API
Estrura
-index.js (define os routers)
........ ->routers (define o service a ser utilizado)
................ ->services (onde a rota deve ser executada e retornar o resposta)
Imagem da arquitetura:
captura_Arq_Porj https://ibb.co/bv3t0S
Parâmetro do Request
queryparameter (o do get)
........ex: url/rota?id=10203
........let id = req.params.id
recuperar body
........ex: Post para rota X com body = {id: 12345}
........let id = req.body.id
Convenções do Projeto
- Camelcase (ex: 'chaveDaApi')
- Lógica presente apenas nos 'SERVICES'
- Router apenas chama o Service
- Tentar manter código legível com nomenclaturas significativas
- Comentar código sempre que possível de mandeira direta e clara
POSTMAN
- Utilizar postman para 'testar' api (durante desenvolvimento
DOCUMENTAÇÂO RECOMENDADA
Instalando projeto
- Baixar projeto do git*
- Ir para pasta
./api
- Rodar na linha de comando
npm install
(Rodar sempre que novas dependências forem instaladas) - Rodar em outra linha de comando
mongod
se ouver erro preça ajuda para cássio para criar pasta data - Rondar na linha de comando
npm start
ounpm run dev
(perguntar diferença)
Salvando novas dependências
SALVANDO NO PROJETO DEV E PROD
npm install --save
nome-do-pacote
SALVANDO EM DESENVOLVIMENTO
npm install --save-dev
nome-do-pacote
Para Desinstalar
npm uninstall --save
nome-do-pacote (ou --save-dev)
Editores VS IDE's
- Preferencialmente utizar Visual Studio Code, ou Atom, ou Sublime Não Há Necessidade de utilizar IDE!