eduardofranca1 / spring-rest-api

Spring REST API

Spring RESTful API

Tecnologias:

• Java 11
• Spring Boot
• Spring Data JPA
• Spring Security
• Spring Validation
• JWT
• Amazon S3
• Lombok
• MySQL
• Flyway Migration
• OpenAPI | Swagger

Características:

• DTO (Data Transfer Object)
• Conversão automática de DTO para Entidade
• Mensagens de exceções personalizadas
• JWT - JSON Web Token para autenticação do usuário
• Upload de imagens no Amazon S3 (é necessário inserir suas credenciais da Amazon em application.yml)
• Flyway para o controle e versionamento de dados e tabelas no banco de dados
• Open API para documentação da API

Ferramentas usadas:

• IntelliJ IDEA
• MySQL Workbench
• Postman

Feito com:

• Spring Initializr
• Maven

Como posso testar os endpoints?

Abra sua IDEA de preferência:

• O maven irá baixar as dependências
• Abra a classe WsAvaliacaoApplication clicando na opção Run
• Ou se você tiver o Maven instalado, você pode usar o comando: mvn spring-boot:run no seu console

Você pode usar Insomnia ou Postman para checar os endpoints

Para usar a api é necessário:

1. Primeiro criar um novo usuário na rota: http://localhost:8080/user/register

2. Fazer autenticação com username e password na rota: http://localhost:8080/authenticate para poder acessar outros endpoints:

3. Utilizar o token gerado para poder acessar outros endpoints