Leer documentación de APIs
Traduce cualquier entrada de documentación de API a un comando curl ejecutable
⏱ Estim. ~7 min
01 · Leer
La habilidad no es memorizar APIs. Es saber leer la documentación de cualquier API y traducirla a una solicitud ejecutable en 2 minutos.
Toda API tiene documentación. El formato cambia, pero la estructura es la misma: - Método + ruta — qué solicitud enviar - Path parameters — valores que van incrustados en la ruta de la URL - Query parameters — filtros y opciones, generalmente opcionales - Request body — qué JSON enviar para POST/PUT - Response — qué vas a recibir
Puntos clave
- Los path parameters como {owner} se sustituyen directamente en la ruta de la URL
- Los query parameters van después de ? y son opcionales salvo que digan required
- Los campos del cuerpo en POST/PUT se envían con -d '{...}'
- Siempre revisa primero la sección 'Authentication' de la documentación
02 · Ejemplo de código
Vamos a leer juntos una entrada real de la documentación de la API de GitHub.
Entrada de documentación de 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
Traducida a un comando 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"
Proceso de traducción: 1. Método = GET → no hace falta el flag -X 2. Base URL = https://api.github.com 3. Ruta = /repos/{owner}/{repo}/issues → {owner} se cambia por facebook y {repo} por react 4. Query params = ?state=closed&per_page=10 5. Para repos públicos no hace falta autenticación
03 · Práctica real
Pruébalo tú. Ejecuta este comando para traer issues cerradas de facebook/react.
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=5"
04 · Completar
La documentación dice GET /repos/{owner}/{repo}/commits. Para traer commits del repo torvalds/linux, la ruta de la URL sería: /repos/___/linux/commits
05 · Práctica real
Ahora ata todo. Traduce esta entrada de documentación a un comando curl completo: GET /repos/{owner}/{repo}/commits Query: author (username de GitHub), per_page (máximo 100) Tarea: trae los 5 commits más recientes de torvalds/linux sin filtrar por autor.
curl "https://api.github.com/repos/torvalds/linux/commits?per_page=5"
06 · Quiz
La documentación dice: GET /users/{userId}/orders?status=pending&limit=50. Quieres traer las órdenes pendientes del usuario ID 42, limitadas a 10. ¿Cuál es la ruta correcta?
- /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 · Completar
Cuando la documentación dice GET /repos/{owner}/{repo}/commits, las partes entre llaves como {owner} se llaman _____ parameters.
Otras lecciones de este capítulo
⚠ La experiencia interactiva completa necesita JavaScript. Actívalo y vuelve a cargar la página.
※ Este es un proyecto educativo independiente — no es un producto oficial de Anthropic. Claude™ es una marca registrada de Anthropic, PBC.