diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-04-21 18:48:17 +0200 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-04-21 18:48:17 +0200 |
commit | 1c90663b793c24f309e07bcf74f5bbb5494ae4b6 (patch) | |
tree | abc05f468c8eb810a0a1ce240d614d674a26f9e9 /docs | |
parent | 7d5b4631d0b297b1e29d3cd541a61a1d78b5b999 (diff) | |
download | wallabag-1c90663b793c24f309e07bcf74f5bbb5494ae4b6.tar.gz wallabag-1c90663b793c24f309e07bcf74f5bbb5494ae4b6.tar.zst wallabag-1c90663b793c24f309e07bcf74f5bbb5494ae4b6.zip |
Update API documentation with cURL examples
Diffstat (limited to 'docs')
-rw-r--r-- | docs/en/developer/api.rst | 8 | ||||
-rw-r--r-- | docs/fr/developer/api.rst | 26 |
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 | ||
70 | We'll work with the ``access_token`` value in our next calls. | 70 | We'll work with the ``access_token`` value in our next calls. |
71 | 71 | ||
72 | Curl example: | 72 | cURL example: |
73 | 73 | ||
74 | :: | 74 | :: |
75 | 75 | ||
@@ -126,7 +126,7 @@ returns: | |||
126 | 126 | ||
127 | The ``items`` array is empty. | 127 | The ``items`` array is empty. |
128 | 128 | ||
129 | Curl example: | 129 | cURL example: |
130 | 130 | ||
131 | :: | 131 | :: |
132 | 132 | ||
@@ -186,7 +186,7 @@ returns | |||
186 | 186 | ||
187 | Now, if you execute the previous command (see **Get existing entries**), you'll have data. | 187 | Now, if you execute the previous command (see **Get existing entries**), you'll have data. |
188 | 188 | ||
189 | Curl example: | 189 | cURL example: |
190 | 190 | ||
191 | :: | 191 | :: |
192 | 192 | ||
@@ -245,7 +245,7 @@ returns | |||
245 | 245 | ||
246 | And if you want to list the existing entries (see **Get existing entries**), the array is empty. | 246 | And if you want to list the existing entries (see **Get existing entries**), the array is empty. |
247 | 247 | ||
248 | Curl example: | 248 | cURL 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 | ||
13 | Créer un nouveau client d'API | 13 | Créer un nouveau client d'API |
@@ -69,6 +69,12 @@ Vous obtiendrez : | |||
69 | 69 | ||
70 | Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. | 70 | Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. |
71 | 71 | ||
72 | Exemple 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 | |||
72 | Récupérer les articles existants | 78 | Récupérer les articles existants |
73 | -------------------------------- | 79 | -------------------------------- |
74 | 80 | ||
@@ -120,6 +126,12 @@ retournera : | |||
120 | 126 | ||
121 | Le tableau ``items`` est vide. | 127 | Le tableau ``items`` est vide. |
122 | 128 | ||
129 | Exemple cURL : | ||
130 | |||
131 | :: | ||
132 | |||
133 | curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
134 | |||
123 | Créer votre premier article | 135 | Créer votre premier article |
124 | --------------------------- | 136 | --------------------------- |
125 | 137 | ||
@@ -174,6 +186,12 @@ retournera : | |||
174 | 186 | ||
175 | Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. | 187 | Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. |
176 | 188 | ||
189 | Exemple 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 | |||
177 | Supprimer un article | 195 | Supprimer un article |
178 | -------------------- | 196 | -------------------- |
179 | 197 | ||
@@ -227,6 +245,12 @@ retournera : | |||
227 | 245 | ||
228 | Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. | 246 | Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. |
229 | 247 | ||
248 | Exemple cURL : | ||
249 | |||
250 | :: | ||
251 | |||
252 | curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
253 | |||
230 | Autres méthodes | 254 | Autres méthodes |
231 | --------------- | 255 | --------------- |
232 | 256 | ||