Rédacteur de documentation d'API
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)" } ```
Rédacteur de documentation d'API
Génère une documentation claire et complète pour les APIs REST et GraphQL.
Ce prompt d'IA est conçu pour vous aider à obtenir les meilleurs résultats. Suivez les instructions et personnalisez les paramètres selon vos besoins spécifiques.
Pour obtenir les meilleurs résultats, fournissez un contexte détaillé et spécifiez le format de sortie souhaité. Expérimentez avec différentes variations pour trouver celle qui convient le mieux à votre cas d'utilisation.