Lire une doc d'API
Transformer n'importe quelle entrée de doc d'API en commande curl exécutable
⏱ Estim. ~7 min
01 · Lire
L'objectif n'est pas de mémoriser une API. C'est de savoir lire n'importe quelle doc d'API et la traduire en requête exécutable en 2 minutes.
Chaque API a sa doc. Le format varie, mais la structure est constante : - Méthode + path — quelle requête envoyer - Path parameters — valeurs à insérer dans le path de l'URL - Query parameters — filtres et options facultatifs - Request body — JSON à envoyer pour POST/PUT - Response — ce que tu vas recevoir
Points clés
- Les path parameters comme {owner} se substituent directement dans le path de l'URL
- Les query parameters viennent après ?, et sont facultatifs sauf mention « required »
- Les champs du request body (POST/PUT) s'envoient avec -d '{...}'
- Lis toujours la section « Authentication » de la doc en premier
02 · Exemple de code
On lit ensemble une vraie entrée de doc d'API GitHub.
Entrée de doc d'API
GET /repos/{owner}/{repo}/issues
Path parameters:
owner (string, required) — account owner of the repository
repo (string, required) — name of the repository
Query parameters:
state (string) — "open", "closed", or "all" — default: "open"
labels (string) — comma-separated label names
per_page (integer) — results per page, max 100, default 30
page (integer) — page number of results
Response: Array of issue objects
Traduction en commande curl
# Get all CLOSED issues for facebook/react, 10 per page
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=10"
Le processus de traduction : 1. Méthode = GET → pas besoin de l'option -X 2. Base URL = https://api.github.com 3. Path = /repos/{owner}/{repo}/issues → remplace {owner} par facebook, {repo} par react 4. Query params = ?state=closed&per_page=10 5. Pas d'authentification nécessaire pour les repos publics
03 · Pratique réelle
À toi. Lance cette commande pour récupérer les issues fermées de facebook/react.
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=5"
04 · Compléter
La doc d'API dit GET /repos/{owner}/{repo}/commits. Pour récupérer les commits du repo torvalds/linux, le path de l'URL devient : /repos/___/linux/commits
05 · Pratique réelle
On enchaîne tout. Traduis cette entrée de doc en commande curl complète : GET /repos/{owner}/{repo}/commits Query : author (username GitHub), per_page (max 100) Mission : récupère les 5 derniers commits de torvalds/linux, sans filtre d'auteur.
curl "https://api.github.com/repos/torvalds/linux/commits?per_page=5"
06 · Quiz
La doc d'API dit : GET /users/{userId}/orders?status=pending&limit=50. Tu veux récupérer les commandes de l'utilisateur ID 42, status pending, en limitant à 10 résultats. Quel est le path correct ?
- /users?userId=42/orders?status=pending&limit=10
- /users/{42}/orders?status=pending&limit=10
- /users/42/orders?status=pending&limit=10
- /users/42/orders&status=pending&limit=10
07 · Compléter
Quand la doc d'API écrit GET /repos/{owner}/{repo}/commits, les parties entre accolades comme {owner} s'appellent des _____ parameters.
Autres leçons de ce chapitre
⚠ L'expérience interactive complète nécessite JavaScript. Active-le et recharge la page.
※ Ce site est un projet éducatif indépendant — pas un produit officiel d'Anthropic. Claude™ est une marque déposée d'Anthropic, PBC.