Chapitre 05 — Lire la documentation d’une API4 min de lecture

Quiz du chapitre

Testez-vous

Vous avez appris à naviguer dans la documentation API, à lire des pages d'endpoints et à construire des requêtes personnalisées à partir de tables de paramètres. Voyons ce qui a été retenu.


S'orienter dans la documentation

Vous consultez la documentation d'une nouvelle API. Que devez-vous chercher en premier ?

Qu'est-ce que la 'base URL' dans la documentation API ?


Lire les paramètres

Vous voyez ceci dans la doc : pageSize (integer, optionnel, défaut : 20). Que se passe-t-il si vous n'incluez pas pageSize dans votre requête ?

Un paramètre est marqué comme 'required' dans la doc. Qu'est-ce que ça signifie ?

La doc indique qu'un paramètre accepte le type string. Laquelle de ces valeurs est valide ?


Comprendre les réponses

Le schéma de réponse indique qu'un champ price a le type integer et la description 'Prix en centimes.' Vous voyez price: 1499 dans la réponse. Quel est le prix réel ?

Vous voyez une réponse qui contient total: 847, page: 1, limit: 20. Qu'est-ce que ça vous dit ?


Tout assembler

Vous voulez des articles sur les 'véhicules électriques' depuis l'endpoint /everything de NewsAPI. La doc dit que q est requis et sortBy est optionnel (défaut : publishedAt). Quelle URL est correcte ?


Vous avez terminé le Chapitre 5. Vous pouvez maintenant ouvrir la documentation de n'importe quelle API et savoir exactement où regarder : authentification d'abord, puis endpoints, puis paramètres. Vous connaissez la différence entre requis et optionnel, vous savez lire un schéma de réponse, et vous avez construit des requêtes personnalisées à partir d'une vraie table de paramètres. Quand votre équipe technique partage une doc API, vous saurez comment la naviguer.