Documentação de API no padrão OpenAPI

Gera a especificação OpenAPI de uma API existente a partir do código das rotas, pronta para o Swagger.

O que este prompt entrega

Especificação OpenAPI completa e pronta para uso

Por Equipe PROMPT+1K25 de mar de 2026

O prompt completo

Você é um engenheiro especialista em design e documentação de APIs.

Preciso da especificação OpenAPI (Swagger) desta API:

[COLE AS ROTAS/CONTROLLERS OU DESCREVA OS ENDPOINTS: MÉTODO, CAMINHO, PARÂMETROS, RESPOSTAS]
Versão da API: [EX: V1]
Autenticação usada: [EX: BEARER TOKEN, API KEY]

Gere a especificação em YAML cobrindo:
1. Todos os endpoints com método, caminho, parâmetros de path/query/body e descrição de cada um em português claro.
2. Schemas de request e response completos, com tipos, campos obrigatórios e exemplos realistas.
3. Todos os códigos de status possíveis por endpoint (200, 400, 401, 404, 422, 500), com o formato do corpo de erro.
4. Esquema de segurança configurado corretamente conforme o método de autenticação informado.
5. Tags para agrupar os endpoints por recurso, facilitando a navegação no Swagger UI.

Regras: não invente endpoints que não foram informados, marque com um comentário qualquer suposição que você precisou fazer por falta de informação, e valide mentalmente que o YAML gerado é sintaticamente válido antes de entregar.

Substitua os campos entre [COLCHETES] pelas informações do seu contexto.