Lendo a documentação de uma API
Traduza qualquer entrada de documentação de API em um comando curl executável
⏱ Estim. ~7 min
01 · Ler
A habilidade não é decorar APIs. É ler a documentação de qualquer API e, em 2 minutos, traduzir em uma requisição executável.
Toda API tem documentação. O formato varia, mas a estrutura é consistente:- Method + path — que tipo de requisição fazer - Path parameters — valores embutidos no path da URL - Query parameters — filtros e opções opcionais - Request body — qual JSON enviar em POST/PUT - Response — o que você recebe de volta
Pontos-chave
- Path parameters como {owner} entram direto no path da URL
- Query parameters vêm depois do ?; os que não estão marcados como required são opcionais
- Campos do corpo de requisições POST/PUT são enviados com -d '{...}'
- Leia primeiro a seção "Authentication" (autenticação) da documentação
02 · Exemplo de código
Vamos ler juntos uma entrada real da documentação da API do GitHub.
Entrada da documentação
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
Tradução para 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"
Processo de tradução: 1. Method = GET → sem flag -X 2. Base URL = https://api.github.com 3. Path = /repos/{owner}/{repo}/issues → {owner} vira facebook, {repo} vira react 4. Query params = ?state=closed&per_page=10 5. Repositório público não exige autenticação
03 · Prática real
Tente você. Rode este comando para pegar issues fechadas do facebook/react.
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=5"
04 · Preencher
A documentação da API diz GET /repos/{owner}/{repo}/commits. Para pegar commits do repo torvalds/linux, o path da URL fica: /repos/___/linux/commits
05 · Prática real
Agora junte tudo. Traduza esta entrada de documentação em um comando curl completo: GET /repos/{owner}/{repo}/commits Query: author (username do GitHub), per_page (máximo 100) Tarefa: pegue os 5 commits mais recentes do torvalds/linux, sem filtrar por autor.
curl "https://api.github.com/repos/torvalds/linux/commits?per_page=5"
06 · Quiz
A documentação diz: GET /users/{userId}/orders?status=pending&limit=50. Você quer pedidos do user ID 42, status pending, limitados a 10. Qual é o path correto?
- /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 · Preencher
Quando a documentação diz GET /repos/{owner}/{repo}/commits, as partes entre chaves como {owner} se chamam _____ parameters.
Outras lições deste capítulo
⚠ A experiência interativa completa precisa de JavaScript. Ative-o e recarregue a página.
※ Este é um projeto educacional independente — não é um produto oficial da Anthropic. Claude™ é uma marca registrada da Anthropic, PBC.