/to-do

CRUD utilizando MongoDB para aprender mais sobre o Spring Data MongoDB

Primary LanguageJava

👨‍💻‍Sobre o projeto

Esse projeto foi feito com o intuito de aprender mais sobre o Spring Data MongoDB.

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

Para mais informações sobre as configurações do banco, acesse src/main/resources/application.yml ou docker-compose.yml (caso esteja usando Docker).

💿Como rodar na sua máquina

🐳Utilizando Docker

Pré-requisitos:

  • Git;
  • Docker + Docker-Compose;
# Clone o repositório na sua máquina
$ git clone https://github.com/lleonardus/to-do.git

# Abra a pasta do projeto
$ cd to-do

# 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
  • MongoDB
# Clone o repositório na sua máquina
$ git clone https://github.com/lleonardus/to-do.git

# Abra a pasta do projeto
$ cd to-do

# 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...)

🎯Endpoints

📜Tasks

  • GET /tasks: Retorna uma lista com todas as tasks.
  • GET /tasks/status?completed=boolean: Retorna uma lista de tasks baseada no status.
  • GET /tasks/{id}: Retorna uma task em específico.
  • POST /tasks: Registra uma nova task.
  • PUT /tasks/{id}: Atualiza uma task.
  • DELETE /tasks/{id}: Deleta uma task em específico.

🧰Ferramentas Utilizadas