API-Dokumentationsschreiber
Why this prompt matters
Consistent API docs reduce integration time. This structured prompt ensures no critical section is missed.
What we use it for
Technical writing
Prompt
Write REST API documentation for the following endpoint. Include: HTTP method, URL, request headers, request body (with types), response codes with example bodies, error scenarios, and a curl example. Use clear, concise language aimed at developers.
Result
## POST /api/v1/users
Creates a new user account.
### Headers | Header | Value | Required | |--------|-------|----------| | Content-Type | application/json | Yes | | Authorization | Bearer {token} | Yes |
### Request Body ```json { "email": "string (required)", "name": "string (required)", "role": "admin | user (default: user)" } ```
API-Dokumentationsschreiber
Generiert klare und vollständige Dokumentation für REST- und GraphQL-APIs.
Dieser KI-Prompt ist darauf ausgelegt, Ihnen die besten Ergebnisse zu liefern. Folgen Sie den Anweisungen und passen Sie die Parameter an Ihre spezifischen Bedürfnisse an.
Für die besten Ergebnisse geben Sie detaillierten Kontext an und spezifizieren Sie das gewünschte Ausgabeformat. Experimentieren Sie mit verschiedenen Variationen, um die beste für Ihren Anwendungsfall zu finden.