Escritor de documentación de API
Por qué importa este prompt
Consistent API docs reduce integration time. This structured prompt ensures no critical section is missed.
Para qué lo usamos
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.
Resultado
## 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)" } ```
Escritor de documentación de API
Genera documentación clara y completa para APIs REST y GraphQL.
Este prompt de IA está diseñado para ayudarte a obtener los mejores resultados. Sigue las instrucciones y personaliza los parámetros según tus necesidades específicas.
Para obtener los mejores resultados, proporciona contexto detallado y especifica el formato de salida deseado. Experimenta con diferentes variaciones para encontrar la que mejor se adapte a tu caso de uso.