Escritor de documentação de API
Porque é que este prompt importa
Consistent API docs reduce integration time. This structured prompt ensures no critical section is missed.
Para que o 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 documentação de API
Gera documentação clara e completa para APIs REST e GraphQL.
Este prompt de IA foi projetado para ajudá-lo a obter os melhores resultados. Siga as instruções e personalize os parâmetros de acordo com suas necessidades específicas.
Para obter os melhores resultados, forneça contexto detalhado e especifique o formato de saída desejado. Experimente diferentes variações para encontrar a que melhor se adapta ao seu caso de uso.