Skip to content

Commit 64ba7a6

Browse files
docs: Update README.md
1 parent b7dfd30 commit 64ba7a6

File tree

1 file changed

+38
-11
lines changed

1 file changed

+38
-11
lines changed

README.md

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,52 @@
11
# Spring Boot API
22

33
## Descrição
4-
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.
4+
Este projeto é uma API de autenticação desenvolvida com **Spring Boot** e **Spring Security**, utilizando **H2** como banco de dados em ambiente de desenvolvimento (**DSV**). A API fornece funcionalidades de **registro** e **login** de usuários e será consumida por um frontend desenvolvido em outro framework.
55

66
## Tecnologias Utilizadas
77
- **Java 17**
88
- **Spring Boot 3**
99
- **Spring Security**
1010
- **Spring Data JPA**
11-
- **MariaDB**
11+
- **H2 Database** (Apenas para DSV)
1212
- **JWT (JSON Web Token)**
1313
- **Maven**
1414

1515
## Requisitos
1616
Antes de rodar o projeto, certifique-se de ter instalado:
1717
- **Java 17** ou superior
18-
- **MariaDB** instalado e rodando
1918
- **Maven** configurado
2019

21-
## Configuração do Banco de Dados
22-
O projeto está configurado para utilizar **MariaDB**. Para configurá-lo, crie um banco de dados e edite o arquivo `application.properties`:
20+
## Configuração do Banco de Dados no Ambiente DSV
21+
No ambiente de desenvolvimento (**DSV**), utilizamos o banco de dados **H2** em memória. Ele é um banco leve, embutido e ideal para testes. O `application.properties` está configurado da seguinte forma:
2322

2423
```properties
25-
spring.datasource.url=jdbc:mariadb://localhost:3306/seu_banco_de_dados
26-
spring.datasource.username=seu_usuario
27-
spring.datasource.password=sua_senha
28-
spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
29-
spring.jpa.database-platform=org.hibernate.dialect.MariaDBDialect
24+
# Configuração do banco de dados para o ambiente de desenvolvimento (DSV)
25+
spring.datasource.url=jdbc:h2:mem:apidsv
26+
spring.datasource.driver-class-name=org.h2.Driver
27+
spring.datasource.username=sa
28+
spring.datasource.password=123
29+
30+
# Configuração do Hibernate (JPA)
31+
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
32+
spring.jpa.hibernate.ddl-auto=update
33+
spring.jpa.show-sql=true
34+
35+
# Habilitar o console web do H2 para visualizar os dados do banco
36+
spring.h2.console.path=/h2
37+
spring.jpa.defer-datasource-initialization=true
3038
```
3139

40+
### Explicação do `application.properties`
41+
- `spring.datasource.url`: Define a URL de conexão do banco H2 em memória.
42+
- `spring.datasource.driver-class-name`: Define o driver JDBC do H2.
43+
- `spring.datasource.username` e `spring.datasource.password`: Credenciais padrão do H2.
44+
- `spring.jpa.database-platform`: Define o dialeto do Hibernate para H2.
45+
- `spring.jpa.hibernate.ddl-auto=update`: Permite que o Hibernate atualize automaticamente o esquema do banco de dados.
46+
- `spring.jpa.show-sql=true`: Exibe no console as consultas SQL executadas.
47+
- `spring.h2.console.path=/h2`: Habilita o console web do H2, acessível em `http://localhost:8080/h2`.
48+
- `spring.jpa.defer-datasource-initialization=true`: Garante que as configurações do banco sejam carregadas corretamente.
49+
3250
## Como Rodar o Projeto
3351
1. Clone o repositório:
3452
```sh
@@ -38,14 +56,22 @@ spring.jpa.database-platform=org.hibernate.dialect.MariaDBDialect
3856
```sh
3957
cd Vava-API
4058
```
41-
3. Trocar branch para DSV no projeto:
59+
3. Troque para a branch DSV:
4260
```sh
4361
git checkout development
4462
```
4563
4. Compile e execute o projeto:
4664
```sh
4765
mvn spring-boot:run
4866
```
67+
5. Para acessar o console do H2, abra o navegador e digite:
68+
```
69+
http://localhost:8080/h2
70+
```
71+
Use as credenciais:
72+
- **JDBC URL**: `jdbc:h2:mem:apidsv`
73+
- **Usuário**: `sa`
74+
- **Senha**: `123`
4975

5076
## Endpoints Disponíveis
5177
A API oferece os seguintes endpoints:
@@ -85,3 +111,4 @@ A API oferece os seguintes endpoints:
85111

86112
## Licença
87113
Este projeto está sob a licença MIT. Sinta-se à vontade para utilizá-lo e modificá-lo.
114+

0 commit comments

Comments
 (0)