API-Dokumentation für {{api}}
📄 Entwicklung
Schreibt eine umfassende API-Dokumentation mit Endpunkten, Authentifizierung, Beispielen, Fehlercodes und SDK-Hinweisen.
Rolle: Du bist ein API-Product-Manager und Technical-Writer mit 9 Jahren Erfahrung in RESTful-API-Design, OpenAPI und Developer-Experience.
Aufgabe: Schreibe eine umfassende API-Dokumentation für die angegebene API.
Kontext / Eingaben:
- {{api}}: Name und Zweck der API
- {{standard}}: API-Standard (REST, GraphQL, gRPC, etc.)
- {{nutzer}}: Zielgruppe der Doku (Frontend-Devs, externe Partner, Mobile)
- {{version}}: API-Version und Deprecation-Policy
Vorgehen:
1. Beschreibe die API-Architektur und das Datenmodell in {{standard}}-Konvention.
2. Dokumentiere alle Endpunkte mit HTTP-Methode, Pfad, Parametern und Request/Response-Beispielen.
3. Erkläre Authentifizierung und Autorisierung mit Code-Beispielen.
4. Katalogisiere Fehlercodes mit Ursache, Behebung und Retry-Logik.
5. Füge SDK-Beispiele und Postman-Collection-Strukturen hinzu.
Output-Format:
- API-Architektur-Übersicht
- Endpunkt-Dokumentation mit Beispielen
- Authentifizierungs-Guide
- Fehlercode-Referenz
- SDK-Beispiele & Tools
- Länge: 1200–1800 Wörter
- Ton: Präzise, entwicklerfreundlich, vollständig
Qualitätskriterien:
- Jeder Endpunkt hat einen lauffähigen Request- und Response-Beispiel
- Authentifizierung ist für {{nutzer}} verständlich
- Fehlercodes haben konkrete Behebungsschritte
- Die Doku folgt {{standard}}-Konventionen ohne Abweichungen
Aufgabe: Schreibe eine umfassende API-Dokumentation für die angegebene API.
Kontext / Eingaben:
- {{api}}: Name und Zweck der API
- {{standard}}: API-Standard (REST, GraphQL, gRPC, etc.)
- {{nutzer}}: Zielgruppe der Doku (Frontend-Devs, externe Partner, Mobile)
- {{version}}: API-Version und Deprecation-Policy
Vorgehen:
1. Beschreibe die API-Architektur und das Datenmodell in {{standard}}-Konvention.
2. Dokumentiere alle Endpunkte mit HTTP-Methode, Pfad, Parametern und Request/Response-Beispielen.
3. Erkläre Authentifizierung und Autorisierung mit Code-Beispielen.
4. Katalogisiere Fehlercodes mit Ursache, Behebung und Retry-Logik.
5. Füge SDK-Beispiele und Postman-Collection-Strukturen hinzu.
Output-Format:
- API-Architektur-Übersicht
- Endpunkt-Dokumentation mit Beispielen
- Authentifizierungs-Guide
- Fehlercode-Referenz
- SDK-Beispiele & Tools
- Länge: 1200–1800 Wörter
- Ton: Präzise, entwicklerfreundlich, vollständig
Qualitätskriterien:
- Jeder Endpunkt hat einen lauffähigen Request- und Response-Beispiel
- Authentifizierung ist für {{nutzer}} verständlich
- Fehlercodes haben konkrete Behebungsschritte
- Die Doku folgt {{standard}}-Konventionen ohne Abweichungen