Prompt completo
"Aja como um especialista em documentação técnica e um desenvolvedor sênior de Spring Boot. Você é responsável por criar um template de documentação abrangente e fácil de usar para *endpoints* RESTful em uma aplicação Spring Boot. O template deve ser aplicável a projetos que utilizam Spring WebFlux (reativo) e Spring MVC (tradicional), e deve ser otimizado para legibilidade e manutenção por outros desenvolvedores. Inclua seções essenciais como: 1. **Visão Geral do Endpoint:** Breve descrição da funcionalidade do endpoint. 2. **URI:** O caminho completo do endpoint (ex: `/api/v1/usuarios/{id}`). 3. **Método HTTP:** (GET, POST, PUT, DELETE, PATCH). 4. **Parâmetros de Caminho (Path Variables):** Nome, tipo, descrição, obrigatoriedade, exemplo. 5. **Parâmetros de Consulta (Query Parameters):** Nome, tipo, descrição, obrigatoriedade, valor padrão (se houver), exemplo. 6. **Corpo da Requisição (Request Body):** * Tipo de conteúdo (Content-Type). * Estrutura JSON/XML esperada (com exemplos claros e anotações para campos obrigatórios/opcionais, tipos de dados). * Descrição de cada campo. 7. **Cabeçalhos da Requisição (Request Headers):** Exemplos de cabeçalhos importantes (Authorization, Content-Type, Accept). 8. **Respostas (Responses):** * Códigos de Status HTTP esperados (200 OK, 201 Created, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 500 Internal Server Error, etc.). * Estrutura JSON/XML de cada resposta (com exemplos e anotações). * Descrição de cada campo na resposta. 9. **Exemplos de Requisição (Curl):** Um ou mais exemplos completos de como consumir o endpoint usando `curl`. 10. **Exemplos de Resposta (JSON/XML):** Um ou mais exemplos completos de respostas reais do endpoint. 11. **Notas Adicionais/Considerações:** Qualquer informação
Tags relacionadas
Spring Boot
Documentação em Spring Boot
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 Spring Boot
ChatGPT
Melhores práticas de ferramentas para spring boot para Spring Boot
Prompt gerado automaticamente para Ferramentas para Spring Boot em Spring Boot
4 usos
ChatGPT
Melhores práticas de documentação em spring boot para Spring Boot
Prompt gerado automaticamente para Documentação em Spring Boot em Spring Boot
4 usos
ChatGPT
Guia para casos de uso práticos em spring boot em Spring Boot
Prompt gerado automaticamente para Casos de uso práticos em Spring Boot em Spring Boot
4 usos