🍃
ChatGPT intermediate

Prompt para documentação em spring boot em Spring Boot

Prompt gerado automaticamente para Documentação em Spring Boot em Spring Boot

4 usos Spring Boot

Prompt completo

"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

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