https://github.com/vavahelper/vava-api
https://github.com/vavahelper/vava-api
api api-rest http-requests java jwt jwt-authentication jwt-tokens spring-boot spring-data-jpa spring-mvc spring-security
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vavahelper/vava-api
- Owner: VavaHelper
- License: mit
- Created: 2025-02-14T00:55:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-25T16:07:33.000Z (over 1 year ago)
- Last Synced: 2025-02-25T17:22:46.708Z (over 1 year ago)
- Topics: api, api-rest, http-requests, java, jwt, jwt-authentication, jwt-tokens, spring-boot, spring-data-jpa, spring-mvc, spring-security
- Language: Java
- Homepage:
- Size: 68.4 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spring Boot API
## Descrição
Este projeto é uma API de autenticação desenvolvida com **Spring Boot** e **Spring Security**, utilizando **MariaDB** como banco de dados. A API fornece funcionalidades de **registro** e **login** de usuários e será consumida por um frontend desenvolvido em outro framework.
## Tecnologias Utilizadas
- **Java 17**
- **Spring Boot 3**
- **Spring Security**
- **Spring Data JPA**
- **MariaDB**
- **JWT (JSON Web Token)**
- **Maven**
## Requisitos
Antes de rodar o projeto, certifique-se de ter instalado:
- **Java 17** ou superior
- **MariaDB** instalado e rodando
- **Maven** configurado
## Configuração do Banco de Dados
O projeto está configurado para utilizar **MariaDB**. Para configurá-lo, crie um banco de dados e edite o arquivo `application.properties`:
```properties
spring.datasource.url=jdbc:mariadb://localhost:3306/seu_banco_de_dados
spring.datasource.username=seu_usuario
spring.datasource.password=sua_senha
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
spring.jpa.database-platform=org.hibernate.dialect.MariaDBDialect
```
## Como Rodar o Projeto
1. Clone o repositório:
```sh
git clone https://github.com/VavaHelper/Vava-API.git
```
2. Acesse o diretório do projeto:
```sh
cd Vava-API
```
3. Compile e execute o projeto:
```sh
mvn spring-boot:run
```
## Como Rodar o Projeto (DSV)
1. Clone o repositório:
```sh
git clone https://github.com/VavaHelper/Vava-API.git
```
2. Acesse o diretório do projeto:
```sh
cd Vava-API
```
3. Acesse a branch DSV:
```sh
git checkout development
```
4. Compile e execute o projeto:
```sh
mvn spring-boot:run
```
## Endpoints Disponíveis
A API oferece os seguintes endpoints:
### Registro de Usuário
- **POST** `/api/auth/register`
- **Request Body:**
```json
{
"username": "exemplo",
"email": "exemplo@email.com",
"password": "senha123"
}
```
### Login de Usuário
- **POST** `/api/auth/login`
- **Request Body:**
```json
{
"email": "exemplo@email.com",
"password": "senha123"
}
```
- **Resposta (sucesso):**
```json
{
"token": "jwt_token_aqui"
}
```
## Futuras Implementações
- Recuperação de senha
- Perfis de usuários (Admin, Usuário Comum)
- Integração com OAuth2
- Atendimento/Suporte ao Usuário Cliente
## Licença
Este projeto está sob a licença MIT. Sinta-se à vontade para utilizá-lo e modificá-lo.