Documentar Projetos em Spring Boot

1 - Introdução 2 - Conceitos 3 - Importando projeto 4 - Dependências 5 - Customizando cabeçalho 6 - Rotas 7 - Modelos 8 - Considerações finais 9 - Considerações finais

2 - Conceitos da documentação de projetos

Olá pessoal, dando continuidade ao nosso treinamento de documentando projetos em Spring Boot, vamos compreender a importância da documentação, veja abaixo as principais vantagens em saber documentar seus projetos:

  • Na documentação, todas as rotas e modelos são disponbilizados para os desenvolvedores compreenderem com facilidade a estrutrua do projeto;
  • Interface amigável para aprender e realizar testes nos projetos;
  • Ganho de produtividade, pois não é necessário acessar o projeto e acessar cada camada, é uma leitura mais simplificada da estrutura;
  • Fácil geração, pois através de annotations a documentação é criada automaticamente;
  • Auxilia toda a equipe a compreender com mais facilidade a regra de negócios do projeto.

Configurando nosso ambiente de desenvolvimento

Certifique-se que tenha os seguintes softwares instalados:

Na próxima aula iremos importar nossa API, configurem o ambiente e nos vemos na próxima aula.

Veja abaixo a introdução desse curso, disponível no YouTube: