Prompt completo
"Você é um especialista em API Design. Crie um prompt detalhado para uma ferramenta de geração automática de documentação OpenAPI (Swagger/AsyncAPI). O prompt deve solicitar a geração de um trecho de documentação para um novo endpoint REST que: 1. **Permite** a criação de um novo recurso "Produto" (método POST). 2. **Requer** autenticação via Bearer Token (OAuth 2.0 ou JWT). 3. **Espera** um corpo de requisição JSON com os campos `nome` (string, obrigatório), `descricao` (string, opcional) e `preco` (número, obrigatório, formato float). 4. **Retorna** um status `201 Created` em caso de sucesso, com o corpo da resposta contendo o ID do produto criado e a data de criação. 5. **Retorna** um status `400 Bad Request` se a validação dos dados de entrada falhar, com uma mensagem de erro descritiva. 6. **Retorna** um status `401 Unauthorized` se a autenticação falhar. 7. **Inclui** exemplos de requisição e resposta para os cenários de sucesso e falha (400 e 401). 8. **Sugere** tags relevantes para o endpoint (e.g., "Produtos", "Catálogo"). A documentação gerada deve ser clara, concisa e seguir as melhores práticas do OpenAPI Specification, incluindo descrições para cada campo, exemplos e referências a componentes de esquema se aplicável. O objetivo é que essa documentação possa ser diretamente integrada em um arquivo `openapi.yaml` ou `openapi.json`."
Tags relacionadas
API Design
Ferramentas para API Design
gerado-automaticamente
Como usar este prompt
1
Clique no botão "Copiar" para copiar o prompt para sua área de transferência
2
Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)
3
Cole o prompt e adapte conforme necessário para seu contexto específico
Outros prompts de API Design
ChatGPT
Guia para troubleshooting em api design em API Design
Prompt gerado automaticamente para Troubleshooting em API Design em API Design
2 usos
ChatGPT
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design
5 usos
ChatGPT
Guia para testing em api design em API Design
Prompt gerado automaticamente para Testing em API Design em API Design
4 usos