Objetivo do projeto:
API Rest simples, contendo uma validação de request, conexão a banco de dados e tratamento de erros, servindo como portfolio.
API que contenha todos os métodos CRUD, Criar, Ler, Atualizar e Deletar Dados em um Banco de Dados. Contém validador de requests, que verificará se os dados que o cliente está enviando a sua API estão corretos. Tratamento de Erros, ao invés de retornar throws e stack traces, retorna http codes correto para acidentes.
+Adicional Conteirização com Docker.
+Adicional Swagger para documentação.
Docker
Yarn instalado na maquina que irá rodar o projeto.
.env
| Variável | Descrição |
|---|---|
| DATABASE_HOSTNAME | Hostname para conexão com o banco de dados |
| DATABASE_USERNAME | Usuario de acesso ao banco de dados |
| DATABASE_PASSWORD | Senha de acesso ao banco de dados |
| DATABASE_DATABASE | Nome do banco de dados |
| DATABASE_PORT | Porta que está rodando o banco de dados |
Iniciar instalação de pacotes necessários com yarn:
yarn
Após isso, rode o docker-compose para que suba os containers necessários
docker-compose -f docker-compose.yml up -d
Executar serviço API:
yarn dev
Se tudo ocorreu bem, após ter criado o .env e configurado corretamente o banco de dados, após executar o comando acima, deverá obter a seguinte mensagem no terminal:
Listening on port 3000
Indicando que o servidor está rodando em localhost na porta 3000
Para olhar a documentação, rode o servidor localmente e acesse a "/api-docs"
- Express - Server Framework
- NodeJs - Server Environment
- Celebrate - Middleware validator
- Swagger-ui-express - Swagger Render
- Swagger-JSdoc - Convert Comments to Swagger
- MongoDb - Non-relational Database
- @JuninhoFreitas - Desenvolvimento e documentação