From c802181126b41ecbc45e501c5426a6aa8b907d84 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 6 Apr 2016 11:30:41 +0200 Subject: [PATCH] Documentation about wallabag API --- docs/en/developer/api.rst | 235 ++++++++++++++++++ docs/en/index.rst | 2 +- docs/fr/developer/api.rst | 235 ++++++++++++++++++ docs/fr/index.rst | 1 + .../Resources/translations/messages.da.yml | 1 + .../Resources/translations/messages.de.yml | 1 + .../Resources/translations/messages.en.yml | 1 + .../Resources/translations/messages.es.yml | 1 + .../Resources/translations/messages.fa.yml | 1 + .../Resources/translations/messages.fr.yml | 1 + .../Resources/translations/messages.oc.yml | 1 + .../Resources/translations/messages.pl.yml | 1 + .../Resources/translations/messages.ro.yml | 1 + .../Resources/translations/messages.tr.yml | 1 + .../themes/baggy/Developer/index.html.twig | 3 +- .../themes/material/Developer/index.html.twig | 3 +- 16 files changed, 486 insertions(+), 3 deletions(-) create mode 100644 docs/en/developer/api.rst create mode 100644 docs/fr/developer/api.rst diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst new file mode 100644 index 00000000..ac00d3a4 --- /dev/null +++ b/docs/en/developer/api.rst @@ -0,0 +1,235 @@ +API documentation +================= + +Thanks to this documentation, we'll see how to interact with the wallabag API. + +Requirements +------------ + +* wallabag freshly (or not) installed on http://localhost:8000 +* ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. +* all the API methods are documented here http://localhost:8000/api/doc + +Creating a new API client +------------------------- + +In your wallabag account, you can create a new API client at this URL http://localhost:8000/developer/client/create. + +Just give the redirect URL of your application and create your client. If your application is a desktop one, put whatever URL suits you the most. + +You get information like this: + +:: + + Client ID: + + 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc + + Client secret: + + 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 + + +Obtaining a refresh token +------------------------- + +For each API call, you'll need a token. Let's create it with this command (replace ``client_id``, ``client_secret``, ``username`` and ``password`` with their values): + +:: + + http POST http://localhost:8000/oauth/v2/token \ + grant_type=password \ + client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ + client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ + username=wallabag \ + password=wallabag + +You'll have this in return: + +:: + + HTTP/1.1 200 OK + Cache-Control: no-store, private + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:44:33 GMT + Host: localhost:8000 + Pragma: no-cache + X-Debug-Token: 19c8e0 + X-Debug-Token-Link: /_profiler/19c8e0 + X-Powered-By: PHP/7.0.4 + + { + "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", + "expires_in": 3600, + "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", + "scope": null, + "token_type": "bearer" + } + +We'll work with the ``access_token`` value in our next calls. + +Getting existing entries +------------------------ + +Documentation for this method: http://localhost:8000/api/doc#get--api-entries.{_format} + +As we work on a fresh wallabag installation, we'll have no result with this command: + +:: + + http GET http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +returns: + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:51:32 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly + X-Debug-Token: 4fbbc4 + X-Debug-Token-Link: /_profiler/4fbbc4 + X-Powered-By: PHP/7.0.4 + + { + "_embedded": { + "items": [] + }, + "_links": { + "first": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "last": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "self": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + } + }, + "limit": 30, + "page": 1, + "pages": 1, + "total": 0 + } + +The ``items`` array is empty. + +Adding your first entry +----------------------- + +Documentation for this method: http://localhost:8000/api/doc#post--api-entries.{_format} + +:: + + http POST http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ + url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +returns + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:07:54 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly + X-Debug-Token: e01c51 + X-Debug-Token-Link: /_profiler/e01c51 + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/1" + } + }, + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "id": 1, + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Now, if you execute the previous command (see **Get existing entries**), you'll have data. + +Deleting an entry +----------------- + +Documentation for this method: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} + +:: + + http DELETE http://localhost:8000/api/entries/1.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +returns + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:19:07 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly + X-Debug-Token: 887cef + X-Debug-Token-Link: /_profiler/887cef + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/" + } + }, + "annotations": [], + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +And if you want to list the existing entries (see **Get existing entries**), the array is empty. + +Other methods +------------- + +We won't write samples for each API method. + +Have a look on the listing here: http://localhost:8000/api/doc to know each method. diff --git a/docs/en/index.rst b/docs/en/index.rst index 66caac39..87b62121 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -42,7 +42,7 @@ The main documentation for this application is organized into a couple sections: :maxdepth: 2 :caption: Developer documentation + developer/api developer/docker developer/translate developer/maintenance - developer/releasing diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst new file mode 100644 index 00000000..9c8e25a9 --- /dev/null +++ b/docs/fr/developer/api.rst @@ -0,0 +1,235 @@ +Documentation de l'API +====================== + +Grâce à cette documentation, nous allons voir comment interagir avec l'API de wallabag. + +Pré-requis +---------- + +* wallabag fraichement installé et disponible à http://localhost:8000 +* ``httpie`` installé sur votre ordinateur (`voir le site du projet `__). Vous pouvez également adapter les commandes en utilisant curl ou wget. +* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc + +Créer un nouveau client d'API +----------------------------- + +Depuis votre wallabag, vous pouvez créer un nouveau client d'API à cette URL http://localhost:8000/developer/client/create. + +Vous devez renseigner l'URL de redirection de votre application et créer votre client. Si votre application est une application desktop, renseignez l'URL que vous souhaitez. + +Vous obtiendrez les informations suivantes : + +:: + + Client ID: + + 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc + + Client secret: + + 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 + + +Créer un jeton +-------------- + +Pour chaque appel d'API, vous aurez besoin d'un jeton. Créons-le avec la commande suivante (remplacez ``client_id``, ``client_secret``, ``username`` and ``password`` par leur valeur): + +:: + + http POST http://localhost:8000/oauth/v2/token \ + grant_type=password \ + client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ + client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ + username=wallabag \ + password=wallabag + +Vous obtiendrez : + +:: + + HTTP/1.1 200 OK + Cache-Control: no-store, private + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:44:33 GMT + Host: localhost:8000 + Pragma: no-cache + X-Debug-Token: 19c8e0 + X-Debug-Token-Link: /_profiler/19c8e0 + X-Powered-By: PHP/7.0.4 + + { + "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", + "expires_in": 3600, + "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", + "scope": null, + "token_type": "bearer" + } + +Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. + +Récupérer les articles existants +-------------------------------- + +Documentation pour cette méthode : http://localhost:8000/api/doc#get--api-entries.{_format} + +Comme nous venons tout juste d'installer wallabag, nous n'aurons aucun résultat avec cette commande : + +:: + + http GET http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +retournera : + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 08:51:32 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly + X-Debug-Token: 4fbbc4 + X-Debug-Token-Link: /_profiler/4fbbc4 + X-Powered-By: PHP/7.0.4 + + { + "_embedded": { + "items": [] + }, + "_links": { + "first": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "last": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + }, + "self": { + "href": "http://localhost:8000/api/entries?page=1&perPage=30" + } + }, + "limit": 30, + "page": 1, + "pages": 1, + "total": 0 + } + +Le tableau ``items`` est vide. + +Créer votre premier article +--------------------------- + +Documentation pour cette méthode : http://localhost:8000/api/doc#post--api-entries.{_format} + +:: + + http POST http://localhost:8000/api/entries.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ + url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" + +retournera : + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:07:54 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly + X-Debug-Token: e01c51 + X-Debug-Token-Link: /_profiler/e01c51 + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/1" + } + }, + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "id": 1, + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. + +Supprimer un article +-------------------- + +Documentation pour cette méthode : http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} + +:: + + http DELETE http://localhost:8000/api/entries/1.json \ + "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" + +retournera : + +:: + + HTTP/1.1 200 OK + 0: application/json + Cache-Control: no-cache + Connection: close + Content-Type: application/json + Date: Tue, 05 Apr 2016 09:19:07 GMT + Host: localhost:8000 + Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly + X-Debug-Token: 887cef + X-Debug-Token-Link: /_profiler/887cef + X-Powered-By: PHP/7.0.4 + + { + "_links": { + "self": { + "href": "/api/entries/" + } + }, + "annotations": [], + "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", + "created_at": "2016-04-05T09:07:54+0000", + "domain_name": "www.numerama.com", + "is_archived": 0, + "is_starred": 0, + "language": "fr-FR", + "mimetype": "text/html", + "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", + "reading_time": 2, + "tags": [], + "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", + "updated_at": "2016-04-05T09:07:54+0000", + "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", + "user_email": "", + "user_id": 1, + "user_name": "wallabag" + } + +Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. + +Autres méthodes +--------------- + +Nous n'écrirons pas d'exemples pour toutes les méthodes de l'API. + +Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour connaitre chaque méthode. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 3a8d361a..628c62a5 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -43,6 +43,7 @@ La documentation principale de cette application est découpée en plusieurs sec :maxdepth: 2 :caption: Documentation développeur + developer/api developer/docker developer/translate developer/maintenance diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.da.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.da.yml index acf9fdc5..d19cf1bf 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.da.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.da.yml @@ -338,6 +338,7 @@ developer: # documentation: 'Documentation' # how_to_first_app: 'How to create my first application' # full_documentation: 'View full API documentation' + # list_methods: 'List API methods' # clients: # title: 'Clients' # create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.de.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.de.yml index 02c998ea..f1e7b6b8 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.de.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.de.yml @@ -338,6 +338,7 @@ developer: documentation: 'Dokumentation' how_to_first_app: 'Wie erstelle ich meine erste Anwendung' full_documentation: 'Komplette API-Dokumentation einsehen' + # list_methods: 'List API methods' clients: title: 'Clients' create_new: 'Neuen Client erstellen' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.en.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.en.yml index 2c3704f3..3dc22998 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.en.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.en.yml @@ -338,6 +338,7 @@ developer: documentation: 'Documentation' how_to_first_app: 'How to create my first application' full_documentation: 'View full API documentation' + list_methods: 'List API methods' clients: title: 'Clients' create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.es.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.es.yml index bcdad5b3..a8fcbcf6 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.es.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.es.yml @@ -338,6 +338,7 @@ developer: # documentation: 'Documentation' # how_to_first_app: 'How to create my first application' # full_documentation: 'View full API documentation' + # list_methods: 'List API methods' # clients: # title: 'Clients' # create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml index f753a918..6be7d22e 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml @@ -338,6 +338,7 @@ developer: # documentation: 'Documentation' # how_to_first_app: 'How to create my first application' # full_documentation: 'View full API documentation' + # list_methods: 'List API methods' # clients: # title: 'Clients' # create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml index e5448ae3..6ff1a3b1 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml @@ -338,6 +338,7 @@ developer: documentation: 'Documentation' how_to_first_app: 'Comment créer votre première application' full_documentation: "Voir la documentation complète de l'API" + list_methods: "Lister toutes les méthodes de l'API" clients: title: 'Clients' create_new: 'Créer une nouveau client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml index 7446fef9..bbd813e2 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml @@ -338,6 +338,7 @@ developer: documentation: 'Documentacion' how_to_first_app: 'Cossí crear vòstra primièra aplicacion' full_documentation: "Veire la documentacion completa de l'API" + # list_methods: 'List API methods' clients: title: 'Clients' create_new: 'Crear un novèl client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml index 340a3634..fb26de89 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml @@ -338,6 +338,7 @@ developer: documentation: 'Dokumentacja' how_to_first_app: 'Jak stworzyć moją pierwszą aplikację' full_documentation: 'Pokaż pełne API' + # list_methods: 'List API methods' clients: title: 'Klienci' create_new: 'Utwórz nowego klienta' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml index 6dd3d56b..bb817cb3 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml @@ -338,6 +338,7 @@ developer: # documentation: 'Documentation' # how_to_first_app: 'How to create my first application' # full_documentation: 'View full API documentation' + # list_methods: 'List API methods' # clients: # title: 'Clients' # create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml b/src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml index 13e3558f..897cc2f4 100644 --- a/src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml +++ b/src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml @@ -338,6 +338,7 @@ developer: # documentation: 'Documentation' # how_to_first_app: 'How to create my first application' # full_documentation: 'View full API documentation' + # list_methods: 'List API methods' # clients: # title: 'Clients' # create_new: 'Create a new client' diff --git a/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/index.html.twig b/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/index.html.twig index e12779b7..7ff64ca6 100644 --- a/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/index.html.twig +++ b/src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/index.html.twig @@ -14,7 +14,8 @@

{{ 'developer.clients.title'|trans }}

diff --git a/src/Wallabag/CoreBundle/Resources/views/themes/material/Developer/index.html.twig b/src/Wallabag/CoreBundle/Resources/views/themes/material/Developer/index.html.twig index e12779b7..7ff64ca6 100644 --- a/src/Wallabag/CoreBundle/Resources/views/themes/material/Developer/index.html.twig +++ b/src/Wallabag/CoreBundle/Resources/views/themes/material/Developer/index.html.twig @@ -14,7 +14,8 @@

{{ 'developer.clients.title'|trans }}

-- 2.41.0