Prompt para documentação em spring boot em Spring Boot
Prompt gerado automaticamente para Documentação em Spring Boot em Spring Boot
"Você é um especialista em Spring Boot. Sua tarefa é gerar um guia passo a passo, detalhado e técnico, sobre como criar e manter uma documentação de API RESTful completa e automatizada em um projeto Spring Boot, utilizando o ecossistema OpenAPI (Swagger/Springdoc OpenAPI). O guia deve cobrir desde a configuração inicial das dependências e anotações, passando pela organização do código para refletir a documentação, até a geração e disponibilização do UI interativo (Swagger UI). Inclua exemplos de código Java para controladores (com `PathVariable`, `RequestBody`, `RequestParam`), modelos de dados e tratamento de erros. Discuta as melhores práticas para descrever cada endpoint (parâmetros, respostas, códigos de status HTTP) e como adicionar metadados como tags, descrições e exemplos. Aborde também a integração com testes de integração para validar a documentação e como manter a documentação atualizada automaticamente com base nas alterações do código. Por fim, mencione ferramentas e estratégias para publicar e versionar essa documentação."
Tags relacionadas
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de Spring Boot
Continue explorando prompts nesta categoria.
Melhores práticas de documentação em spring boot para Spring Boot
Prompt gerado automaticamente para Documentação em Spring Boot em Spring Boot
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
Estratégias de padrões de design em spring boot em Spring Boot
Prompt gerado automaticamente para Padrões de design em Spring Boot em Spring Boot