👨‍💻‍Sobre o projeto

Esse projeto é inspirado no desafio técnico da Forleven para desenvolvedores backend.

Através dessa API é possível criar, buscar, atualizar e deletar estudantes.

💿Como rodar na sua máquina

🐳Utilizando Docker (Recomendado)

Pré-requisitos:

• Git;
• Docker + Docker Compose.

# Clone o repositório na sua máquina
$ git clone https://github.com/lleonardus/student-manager.git

# Abra a pasta do projeto
$ cd student-manager

# Inicie o projeto usando Docker
$ docker-compose up -d

Após esse processo, a API vai estar rodando em http://localhost:8080 e a documentação estará disponível em http://localhost:8080/swagger-ui.html.

♨️Utilizando Maven

Pré-requisitos:

• Git;
• Maven;
• Java 17;
• PostgreSQL.

# Clone o repositório na sua máquina
$ git clone https://github.com/lleonardus/student-manager.git

# Abra a pasta do projeto
$ cd student-manager

# Inicie o projeto usando Maven
$ mvn spring-boot:run

Após esse processo, a API vai estar rodando em http://localhost:8080 e a documentação estará disponível em http://localhost:8080/swagger-ui.html

Obs: Caso não queira utilizar nenhuma das opções acima, ainda é possível rodar o projeto utilizando uma IDE da sua preferência (Intellij, Eclipse...)

💾Banco de Dados

O banco utilizado na aplicação é o PostgreSQL. Para saber mais sobre as suas configurações, vá em src/main/resources/application.properties e também em docker-compose.yml (caso esteja usando Docker).

🎯Endpoints

👨‍🎓Student

• GET /students: Retorna uma lista de estudantes baseada nos parâmetros passados (id, enrollment, name e lastName).
• GET /students/{enrollment}: Retorna um estudante com base na matrícula passada.
• POST /students: Registra uma novo estudante.
• PUT /students/{id}: Atualiza os campos enrollment, name e lastName de um estudante.
• DELETE /students/{id}: Deleta um estudante em específico.

🧰Ferramentas Utilizadas

• Java 17
• Spring Boot
• Spring Data JPA
• PostgreSQL
• SpringDoc OpenAPI
• Docker
• Maven
• Lombok