API-Dokumentationen lesen
Jeden Doku-Eintrag in einen lauffähigen curl-Befehl übersetzen
⏱ ca. ~7 Min
01 · Lesen
Die Fähigkeit ist nicht, APIs auswendig zu lernen. Sondern jede API-Doku zu lesen und in 2 Minuten in eine lauffähige Anfrage zu übersetzen.
Jede API hat eine Doku. Die Formate unterscheiden sich, aber die Struktur ist konsistent: - Method + Path — was für eine Anfrage senden - Path-Parameter — Werte, die direkt im URL-Pfad eingebettet sind - Query-Parameter — optionale Filter und Optionen - Request-Body — welches JSON bei POST/PUT zu senden ist - Response — was du zurückbekommst
Kernpunkte
- Path-Parameter wie {owner} werden direkt in den URL-Pfad eingesetzt
- Query-Parameter stehen nach ? und sind optional, wenn nicht als required markiert
- Felder im Request-Body bei POST/PUT werden mit -d '{...}' gesendet
- Immer zuerst den „Authentication"-Abschnitt der Doku lesen
02 · Code-Beispiel
Lass uns gemeinsam einen echten Eintrag aus der GitHub-API-Doku lesen.
API-Doku-Eintrag
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
In curl-Befehl übersetzt
# Get all CLOSED issues for facebook/react, 10 per page
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=10"
Der Übersetzungs-Prozess: 1. Method = GET → keine -X-Option nötig 2. Base-URL = https://api.github.com 3. Path = /repos/{owner}/{repo}/issues → {owner} durch facebook ersetzen, {repo} durch react 4. Query-Params = ?state=closed&per_page=10 5. Keine Authentifizierung nötig für öffentliche Repos
03 · Echte Übung
Probiere es selbst. Führe diesen Befehl aus, um die geschlossenen Issues von facebook/react zu holen.
curl "https://api.github.com/repos/facebook/react/issues?state=closed&per_page=5"
04 · Ausfüllen
Die API-Doku sagt GET /repos/{owner}/{repo}/commits. Um die Commits des Repos torvalds/linux zu holen, lautet der URL-Path: /repos/___/linux/commits
05 · Echte Übung
Jetzt alles zusammen. Übersetze diesen Doku-Eintrag in einen vollständigen curl-Befehl: GET /repos/{owner}/{repo}/commits Query: author (GitHub-Username), per_page (max 100) Aufgabe: Hol die 5 letzten Commits von torvalds/linux, ohne Autor-Filter.
curl "https://api.github.com/repos/torvalds/linux/commits?per_page=5"
06 · Quiz
Die API-Doku sagt: GET /users/{userId}/orders?status=pending&limit=50. Du willst Bestellungen für User-ID 42 mit Status pending, limitiert auf 10. Wie lautet der korrekte Pfad?
- /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 · Ausfüllen
Wenn die API-Doku GET /repos/{owner}/{repo}/commits sagt, heißen die Teile in geschweiften Klammern wie {owner} _____-Parameter.
Andere Lektionen aus diesem Kapitel
⚠ Das volle interaktive Erlebnis braucht JavaScript. Bitte aktiviere es und lade die Seite neu.
※ Diese Seite ist ein unabhängiges Bildungsprojekt — kein offizielles Anthropic-Produkt. Claude™ ist eine eingetragene Marke von Anthropic, PBC.