Swagger com Spring Boot

Descrição

Este projeto tem como objetivo demonstrar a utilização do Swagger para documentação de APIs em uma aplicação Spring Boot. Ele implementa um CRUD básico para gerenciar pessoas, utilizando anotações do Swagger para fornecer descrições detalhadas dos endpoints, parâmetros, respostas e modelos de dados. Isso facilita a compreensão e o uso da API por desenvolvedores, tornando a integração mais eficiente.

Funcionalidades:

• Cadastro de Pessoas: Adiciona novas pessoas ao banco de dados.
• Consulta de Pessoas: Obtém todas as pessoas cadastradas ou busca por uma pessoa específica por ID.
• Atualização de Pessoas: Modifica os dados de uma pessoa já cadastrada.
• Exclusão de Pessoas: Remove uma pessoa do banco de dados.

How to

Pré-requisitos

• IDE de preferência (Vscode, Eclipse, Intellij)
• Java 17 ou superior
• Maven 3.2.5 ou superior

Etapas

• Com o bash aberto dentro do diretório da pasta, rode os seguintes comandos:

mvn clean

mvn package

java -jar target/spring-boot-swagger.0.0.1-SNAPSHOT.jar

Instruções de uso

• Com o programa rodando você pode fazer os testes das requisições
• Você pode usar ferramentas como o Postman ou Insomnia para testar as requisições
• Com o projeto em execução, pesquise em seu navegador por http://localhost:8080/swagger-ui.html lá estará a documentação e requisições criadas pelo Swagger.

Contribuições

Acredito que faltam muitas coisas para acrescentar aqui então se sinta livre para contriubuir com este projeto. Sinta-se à vontade para enviar pull requests com melhorias, correções de bugs ou novos recursos.

Contato