Título da Prática: Habilitando a documentação de uma API com Springdoc.

Objetivos: Configurar e utilizar a documentação de uma API com a biblioteca Springdoc e com o Swagger UI.

Materiais, Métodos e Ferramentas: IDE (Spring Tool Suite; Jetbrains Intellij; etc)

A documentação de uma API traz inúmeros benefícios para o próprio desenvolvedor e seu time, além de facilitar a compreensão e uso por parte dos clientes. Entre as várias ferramentas para documentar uma API, a Springdoc se destaca por sua simplicidade e facilidade de configuração. Nesta prática, o objetivo é habilitar essa biblioteca em um projeto de API desenvolvido com o framework Spring Boot, seguindo os passos abaixo:

1. Desenvolvimento da API Funcional: Certifique-se de ter uma API funcional com pelo menos um Controller contendo alguns métodos.

2. Inclusão da Dependência Springdoc no pom.xml: Adicione a dependência referente à biblioteca Springdoc no arquivo pom.xml do projeto.

3. Acesso ao Swagger UI: Utilize um navegador para acessar a página do Swagger UI, que será gerada automaticamente após a configuração do Springdoc.

4. Teste dos Métodos na Interface do Swagger: Experimente e teste alguns dos métodos disponíveis no seu Controller utilizando o Swagger UI.

Para executar este projeto, é recomendado o uso de uma IDE como o Spring Tool Suite ou Jetbrains Intellij para garantir a facilidade e agilidade no desenvolvimento.

Este projeto tem como propósito utilizar a Springdoc, junto ao Swagger, para documentar uma API que recebe informações de nome, autor e data de lançamento de N livros.

Sinta-se à vontade para expandir e personalizar esta documentação conforme as necessidades do seu projeto.