- José Augusto Santos Rodrigues
- https://www.linkedin.com/in/augusto-rodrigues/
Neste desafio o ponto chave era a não utilização de banco de dados para realização das ações dos endpoints, os dados deveriam ser gravados em um arquivo com extensão JSON que faria o papel de banco de dados da aplicação. Dessa forma a lógica de CRUD para banco de dados teve que ser implementada. A API é responsável por cadastrar regras de marcação de horários em uma clínica, existem três categorias de regras e foram implementadas apenas algumas das verificações necessárias com objetivo na avaliação do desafio.
- Node.js
- Express
- Typescript
- Jest
- Apidoc
O caminho para o arquivo database.json deve ser atualizado para corresponder ao seu caminho local quando for feito um clone do projeto.
Para instalar as dependências do projeto utilize um dos compandos a baixo:
npm installou
yarnPara iniciar o projeto em modo de desenvolvimento rode os scripts abaixo com npm ou yarn:
yarn watch-tsyarn watch-nodePara rodar os testes, mude para a branch tests execute o script:
yarn testPara gerar a documentação atualizada da API é necessário ter o apidoc instalado globalmente e executar o comando:
yarn global apidocapidoc -f routes.ts -o public/apidocCom o projeto em execução, explore a documentação da api no path 'http://localhost:3000/apidoc'.
Com o projeto em execução, utilize a Postman Collection (cubos-backend-challenge.postman_collection.json) para utilizar as funcionalidades da API.