igorgbr/nodejs-api-rest-gerenciador-de-carros

API Restful com CRUD e conexão com MongoDB para gerenciar o cadastro de carros em um sistema

🚧Gerenciador de Carros🚧

💻 Sobre o projeto

♻️ NodeJS: API RESTful com CRUD & MONGODB

Preview

✨ Clone

git clone https://github.com/FVitor7/PyMaster-Pes2021-stats-to-PES6.git

🚀 Como executar (Yarn)

• Rode o código: yarn install para instalar as dependências.
• Insira o usuário e senha do seu banco de dados MongoDB no arquivo .env
• Rode o yarn dev para iniciar a aplicação.

Por fim, o Swagger aplicação estará disponível na url: http://localhost:3333/api-docs

Para acessar a API com todos os carros cadastrados: url: http://localhost:3000/api/v1/carros

Para obter um carro específico por ID: url: http://localhost:3000/api/v1/carros/_id

CRUD

• Obter todos os carros cadastrados - GET

• Obter um carro específico por ID - GET

• Cadastrar um novo carro no banco de dados - POST

• Atualizar um carro específico por ID - PUT

• Deletar um carro específico por ID DELETE

Paginação da API

• listagem dos carros

• {{ base_url }}/api/v1/carros?page=2 : retorna a segunda página de objetos

😯 Como contribuir para o projeto

1. Faça um fork do projeto.

2. Crie uma nova branch com as suas alterações: git checkout -b my-feature

3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"

4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Fábio Vitor 👋🏽 Entre em contato!