itFortgeschrittenChatGPTClaude
API-Dokumentation Generator
Erstellt strukturierte API-Dokumentation mit Beispielen, Fehlercodes und Best Practices.
1,234× verwendet•Kompatibel mit: ChatGPT, Claude
Der Prompt
Du bist ein Technical Writer mit Fokus auf Developer-Experience. Erstelle API-Dokumentation für: **API-Name:** [API] **Basis-URL:** [URL] **Authentifizierung:** [BEARER / API-KEY / OAUTH2] **Endpoint zu dokumentieren:** [ENDPOINT + HTTP-METHODE] **Request-Body:** [BODY SCHEMA] **Response-Body:** [RESPONSE SCHEMA] **Mögliche Fehlercodes:** [FEHLER] Struktur: 1. **Endpoint-Header** - HTTP-Methode + Pfad - Kurze Beschreibung (1 Satz) - Authentifizierungs-Hinweis - Rate Limits (falls vorhanden) 2. **Parameter** - Path-Parameter (Tabelle: Name, Typ, Required, Beschreibung) - Query-Parameter (gleiche Tabelle) - Header-Parameter 3. **Request-Body** - JSON Schema - Beispiel-Request - Feldbeschreibungen (Name, Typ, Required, Beispiel, Validierung) 4. **Response** - Success-Response (200/201) mit JSON-Beispiel - Feldbeschreibungen - Error-Responses (400, 401, 403, 404, 500) mit Beispielen 5. **Code-Beispiele** (in 3 Sprachen): - cURL - JavaScript (Fetch) - Python (Requests) 6. **Hinweise & Best Practices** - Idempotenz - Pagination (falls vorhanden) - Versionierung - Rate Limit Handling Stil: präzise, entwicklerfreundlich, ohne Marketing-Phrasen.
Anzupassende Variablen
[API][URL][AUTH][ENDPOINT][BODY SCHEMA][RESPONSE SCHEMA][FEHLER]Warum dieser Prompt funktioniert
Schlechte API-Dokumentation ist der grösste Reibungspunkt für Entwickler. Dieser Prompt erzwingt die vollständige Dokumentation inklusive Fehlercodes und Mehrsprachen-Code-Beispiele, das sind die Dinge, die am häufigsten vergessen werden.
Beispielausgabe
## POST /api/chat
Sendet eine Nachricht an den KI-Chat-Assistenten und erhält eine gestreamte Antwort.
**Auth:** Bearer Token erforderlich
**Rate Limit:** 60 Requests pro Minute
**Request Body:**
```json
{
"messages": [
{
"id": "msg_1",
"role": "user",
"parts": [{"type": "text", "text": "Hallo"}]
}
]
}
```
**Response (200):** Server-Sent Events Stream
```
data: {"type":"text-delta","delta":"Hallo, wie kann..."}
data: [DONE]
```
**Fehler:**
- 401: Token fehlt oder ungültig
- 429: Rate Limit erreicht
[...]
Häufige Fragen
OpenAPI oder Markdown für API-Docs?
OpenAPI für maschinenlesbare Spec (ermöglicht Auto-Generierung von Clients, Tests), Markdown für menschenlesbare Dokumentation. Beide zusammen ist ideal.