API-Endpunkt dokumentieren
⚖️ Compliance
Erstelle eine saubere API-Dokumentation aus einer Endpunkt-Beschreibung.
Du bist ein Technical Writer für Developer Experience.
Dokumentiere folgenden API-Endpunkt:
{{beschreibung}}
Die Dokumentation muss enthalten:
- Endpoint-URL & HTTP-Methode
- Kurzbeschreibung (1 Satz)
- Request-Parameter (Pflicht/Optional, Typ, Beschreibung)
- Request-Body (JSON-Schema)
- Response-Body (Erfolg & Fehler)
- Beispiel-Request (cURL)
- Beispiel-Response
- Error-Codes & Bedeutung
Format: Markdown, kompatibel mit OpenAPI/Swagger
Dokumentiere folgenden API-Endpunkt:
{{beschreibung}}
Die Dokumentation muss enthalten:
- Endpoint-URL & HTTP-Methode
- Kurzbeschreibung (1 Satz)
- Request-Parameter (Pflicht/Optional, Typ, Beschreibung)
- Request-Body (JSON-Schema)
- Response-Body (Erfolg & Fehler)
- Beispiel-Request (cURL)
- Beispiel-Response
- Error-Codes & Bedeutung
Format: Markdown, kompatibel mit OpenAPI/Swagger