Spring Boot API

📑 Índice

1. Descrição
2. Tecnologias
3. Requisitos
4. Configuração do Banco de Dados
5. Como Rodar
   • Ambiente Padrão
   • Branch de Desenvolvimento
6. Endpoints
7. Fluxo de Autenticação
8. Futuras Implementações
9. Documentação Útil
10. Licença

---

📋 Descrição

Esta API de autenticação foi desenvolvida com Spring Boot e Spring Security, utilizando PostgreSQL como banco de dados.
Ela oferece endpoints para registro e login de usuários, retornando um JWT (JSON Web Token) para acesso seguro, consumível por um frontend separado.

---

🛠 Tecnologias

Camada	Tecnologias
Linguagem	Java 17
Framework	Spring Boot 3, Spring Security, JPA
Banco de Dados	PostgreSQL
Autenticação	JWT (JSON Web Token)
Build & Dep.	Maven

---

✅ Requisitos

• Java 17 ou superior
• PostgreSQL instalado e em execução
• Maven (3.6+)

---

🗄️ Configuração do Banco de Dados

1. Crie um banco no PostgreSQL:

   CREATE DATABASE vava_api;

2. Atualize src/main/resources/application.properties:

   spring.datasource.url=jdbc:postgresql://localhost:5432/vava_api
   spring.datasource.username=seu_usuario
   spring.datasource.password=sua_senha
   
   spring.jpa.hibernate.ddl-auto=update
   spring.jpa.show-sql=true
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect

---

▶️ Como Rodar

Ambiente Padrão (main)

git clone https://github.com/VavaHelper/Vava-API.git
cd Vava-API
mvn clean install
mvn spring-boot:run

Branch de Desenvolvimento (DSV)

git clone https://github.com/VavaHelper/Vava-API.git
cd Vava-API
git checkout development
mvn clean install
mvn spring-boot:run

---

🛣️ Endpoints Disponíveis

Método	Rota	Descrição
POST	/api/auth/register	Registrar novo usuário
POST	/api/auth/login	Autenticar usuário e gerar JWT

▶️ Exemplo de Payload de Registro

{
  "username": "exemplo",
  "email": "[email protected]",
  "password": "senha123"
}

▶️ Exemplo de Payload de Login

{
  "email": "[email protected]",
  "password": "senha123"
}

Resposta (sucesso):

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}

---

🔄 Fluxo de Autenticação

flowchart LR
  A[Cliente envia credenciais] --> B{É novo usuário?}
  B -- Sim --> C[POST /api/auth/register]
  B -- Não --> D[POST /api/auth/login]
  D --> E{Credenciais válidas?}
  C --> F[Usuário criado no DB]
  F --> D
  E -- Sim --> G[Gerar JWT e retornar 200 OK]
  E -- Não --> H[Retornar 401 Unauthorized]
  G --> I[Cliente armazena token]
  I --> J[Requisições subsequentes com Authorization: Bearer <token>]

Loading

---

🚀 Futuras Implementações

• 🔄 Recuperação de senha
• 👥 Perfis de usuário (Admin, Comum)
• 🔐 OAuth2 (Google, Facebook)
• 💬 Sistema de suporte ao cliente

---

📚 Documentação Útil

Tópico	Link
Conventional Commits	https://www.conventionalcommits.org/pt-br/v1.0.0/
Spring Boot	https://spring.io/projects/spring-boot
Spring Security	https://spring.io/projects/spring-security
Hibernate & JPA	https://docs.spring.io/spring-data/jpa/docs/current/reference/html/
Design Patterns em Java	https://refactoring.guru/design-patterns/java

---

📝 Licença

Este projeto está licenciado sob a MIT License. Veja o arquivo LICENSE para mais detalhes.