aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-04-22 08:38:04 +0200
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-04-22 08:38:04 +0200
commit9481187896b00b126afbf05d70fe9fe3621937ec (patch)
treeabc05f468c8eb810a0a1ce240d614d674a26f9e9 /docs
parent7d5b4631d0b297b1e29d3cd541a61a1d78b5b999 (diff)
parent1c90663b793c24f309e07bcf74f5bbb5494ae4b6 (diff)
downloadwallabag-9481187896b00b126afbf05d70fe9fe3621937ec.tar.gz
wallabag-9481187896b00b126afbf05d70fe9fe3621937ec.tar.zst
wallabag-9481187896b00b126afbf05d70fe9fe3621937ec.zip
Merge pull request #1962 from wallabag/update-api-documentation
Update API documentation with cURL examples
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developer/api.rst8
-rw-r--r--docs/fr/developer/api.rst26
2 files changed, 29 insertions, 5 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index 38f0377c..61182dcd 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -69,7 +69,7 @@ You'll have this in return:
69 69
70We'll work with the ``access_token`` value in our next calls. 70We'll work with the ``access_token`` value in our next calls.
71 71
72Curl example: 72cURL example:
73 73
74:: 74::
75 75
@@ -126,7 +126,7 @@ returns:
126 126
127The ``items`` array is empty. 127The ``items`` array is empty.
128 128
129Curl example: 129cURL example:
130 130
131:: 131::
132 132
@@ -186,7 +186,7 @@ returns
186 186
187Now, if you execute the previous command (see **Get existing entries**), you'll have data. 187Now, if you execute the previous command (see **Get existing entries**), you'll have data.
188 188
189Curl example: 189cURL example:
190 190
191:: 191::
192 192
@@ -245,7 +245,7 @@ returns
245 245
246And if you want to list the existing entries (see **Get existing entries**), the array is empty. 246And if you want to list the existing entries (see **Get existing entries**), the array is empty.
247 247
248Curl example: 248cURL example:
249 249
250:: 250::
251 251
diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst
index 9c8e25a9..28ddf105 100644
--- a/docs/fr/developer/api.rst
+++ b/docs/fr/developer/api.rst
@@ -7,7 +7,7 @@ Pré-requis
7---------- 7----------
8 8
9* wallabag fraichement installé et disponible à http://localhost:8000 9* wallabag fraichement installé et disponible à http://localhost:8000
10* ``httpie`` installé sur votre ordinateur (`voir le site du projet <https://github.com/jkbrzt/httpie>`__). Vous pouvez également adapter les commandes en utilisant curl ou wget. 10* ``httpie`` installé sur votre ordinateur (`voir le site du projet <https://github.com/jkbrzt/httpie>`__). Vous pouvez également adapter les commandes en utilisant curl ou wget.
11* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc 11* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc
12 12
13Créer un nouveau client d'API 13Créer un nouveau client d'API
@@ -69,6 +69,12 @@ Vous obtiendrez :
69 69
70Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. 70Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels.
71 71
72Exemple cURL :
73
74::
75
76 curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag"
77
72Récupérer les articles existants 78Récupérer les articles existants
73-------------------------------- 79--------------------------------
74 80
@@ -120,6 +126,12 @@ retournera :
120 126
121Le tableau ``items`` est vide. 127Le tableau ``items`` est vide.
122 128
129Exemple cURL :
130
131::
132
133 curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
134
123Créer votre premier article 135Créer votre premier article
124--------------------------- 136---------------------------
125 137
@@ -174,6 +186,12 @@ retournera :
174 186
175Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. 187Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose.
176 188
189Exemple cURL :
190
191::
192
193 curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html"
194
177Supprimer un article 195Supprimer un article
178-------------------- 196--------------------
179 197
@@ -227,6 +245,12 @@ retournera :
227 245
228Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. 246Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide.
229 247
248Exemple cURL :
249
250::
251
252 curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
253
230Autres méthodes 254Autres méthodes
231--------------- 255---------------
232 256