Skip to content

An API with CRUD to manage a vehicle dealership.Being used the MongoDB database through the Mongoose framework and docker.

Notifications You must be signed in to change notification settings

beterrabaA/car-shop

Repository files navigation

Car Shop

Uma API com CRUD para gerenciar uma concessionária de veículos. Sendo utilizado o banco de dados MongoDB através do framework Mongoose.

Oque foi desenvolvido

  • Desenvolvido endpoints que estaão conectados ao banco de dados seguindo os princípios do REST;
  • Usado conceitos de orientação a objetos para estruturar o código;
  • Trabalhado a criação de testes unitários para garantir a qualidade do código;

Aprendizados

  • Herança e abstração
  • NoSQL
  • POO
  • ODM

Stack utilizada

Back-end: Mongo, Mongoose, Typescript

Documentação da API

Retorna todos os carros

  GET /cars
Parâmetro Tipo Descrição
api_key string Obrigatório. A chave da sua API

Retorna um carro

  GET /cars/${id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer

Cadastra um novo carro

POST /cars
  • O corpo da requisição poderá seguir o formato abaixo:
{
  "model": "Marea",
  "year": 2002,
  "color": "Black",
  "status": true,
  "buyValue": 15.990,
  "doorsQty": 4,
  "seatsQty": 5
}

Atualiza um carro

  PUT /cars/${id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer
  • O corpo da requisição poderá seguir o formato abaixo:
{
  "model": "Marea",
  "year": 1992,
  "color": "Red",
  "status": true,
  "buyValue": 12.000,
  "doorsQty": 2,
  "seatsQty": 5
}

Deleta um carro

  DELETE /cars/${id}
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer

Autores

About

An API with CRUD to manage a vehicle dealership.Being used the MongoDB database through the Mongoose framework and docker.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published