API documentation?

[juju4]

Thanks for sharing this nice software. I'm testing it while comparing with miniflux.
While I manage to get a single article or feed by its id, I didn't find for now how to retrieve all articles or all feeds, with or without criteria (starred, tagged, before/after...)

I reviewed the code but did not help for above case.
This is working

res2 = requests.get(api_url+'/article/7', auth=(api_user, api_pass))
res6 = requests.get(api_url+'/feed/1', auth=(api_user, api_pass), headers={'Content-Type': 'application/json'})

This is not

res3 = requests.get(api_url+'/article', auth=(api_user, api_pass))  # 405
res4 = requests.get(api_url+'/articles', auth=(api_user, api_pass), headers={'Content-Type': 'application/json'})  # 400, Failed to decode JSON object: Expecting value: line 1 column 1
# https://github.com/cedricbonhomme/newspipe/blob/master/newspipe/web/views/article.py#L146
res8 = requests.get(api_url+'/export', auth=(api_user, api_pass))  # 404

hints?
Thanks

[cedricbonhomme]

Hello,

For the export, the URL is:
https://www.newspipe.org/articles/export

It is not part of the API. As you can see this is in the article Flask Blueprint (views/article.py).
From the Web interface, you can go in your personal "Your data" section (/user/management). There is a button for this feature.

For res3, it's normal you can not do a GET on /api/v2.0/article. You must specify an id.

But /api/v2.0/articles should work (res4), so I think there is an issue. I just tested.

Anyway, the API is not really used by the front-end (a little). I planed to re-implement it with Flask-RestX and make it more complete.
It is currently using flask_restful project which is not really well maintained. I do not like the current API of Newspipe.

I think I will work on that this week: implementing a new API for the articles and the feeds.

[juju4]

Thanks for the quick feedback!