Esse projeto é sobre uma API que trabalha com anotações de usuário em um banco de dados.
O código não esta perfeito nem é o objetivo dele, este projeto pessoal foi feito apenas para meu aprendizado de mongoDB/mongoose!
Uma API (Application Programming Interface) é uma interface que permite a comunicação entre diferentes sistemas ou aplicações. Ela define como os dados devem ser enviados e recebidos, quais são os formatos aceitos, quais são as regras de autenticação, entre outras especificações.
🧰 Servidor: Desta vez optei por uma separação de responsabilidades maior nos arquivos, além de validações básicas de dados. Este não é um MVC completo nem lida com autenticação de usuário.
🗂 Banco de dados: mongoose é um framework utilizado para modelagem de dados em MongoDB. Foi uma experiência de descoberta utilizar um banco de dados NoSQL e um desafio entender suas diferenças como discriminator, refs e querys.
🤓📚 Documentação e testes: Para ter documentar e garantir o bom funcionamento da API foi utilizado o Swagger UI que permite visualizar e interagir a API utilizando seus parâmetros e respostas em uma interface amigável e padronizada para os usuários finais.
Em resumo foi possível aprender e praticar:
- Banco de dados com MongoDB e Mongoose
- Rotas de uma API e querys para o banco com NodeJS + Express
- Documentação e testagem com Swagger UI
É importante ter o mongoDB rodando e criar/configurar seu arquivo .env com a string de conexão!
Após clonar, baixar ou fazer um fork, utilize o comando abaixo para instalar as dependências do projeto:
npm installPara rodar:
npm run devEsse projeto te permite:
- Buscar dados através das rotas GET como por exemplo: dados de usuário e anotações criadas.
- Adicionar anotações e usuários através das rotas POST
- Editar anotações e usuários através das rotas PUT
- Remover anotações e usuários através das rotas DELETE
💌 Para me mandar uma mensagem basta usar um dos botões abaixo!
