sw-api-node-v1
Projeto com o objetivo final de criar uma api que realize as 4 operações do HTTP: GET, DELETE, PUT & POST. Utilizando das boas práticas de programação e realizando o TDD.
MIT License
Star Wars API Node.JS by Glaucia Lemos
Projeto com o objetivo final de criar uma api que realize as 4 operaes do HTTP: GET, DELETE, PUT & POST. Utilizando das boas prticas de programao e realizando o TDD.
Recursos Utilizados no Desenvolvimento:
- Node.Js;
- Express.Js
- MongoDb & MLab;
- ES6;
- Babel (Transpiler);
- Code Metrics; (anlise de desenvolvimento do codigo)
- Visual Studio Code;
- Json data (para retornar os dados);
- PostMan (testar a API criada);
- TDD (Testes de Unidade e Integrao);
- Mocha, Chai, Sinon & Supertest;
- BDD (Behaviour Driven Development);
Testando a Aplicao no Postman:
Caso queira testar as API's criadas no projeto, primeiro baixe o Postman. Depois de realizar o download do Postman, basta agora realizar os passos abaixo para poder testar cada API criada!
Executar Localmente
Caso voc deseja executar o projeto na sua mquina local, basta seguir os passos abaixo:
Comeando...
Para comear, voc deve simplesmente clonar o repositrio do projeto na sua mquina e instalar as dependncias.
Pre-Requisitos
Antes de instalar as dependncias no projeto, voc precisa j ter instalado na sua mquina:
- Node.Js: Caso no tenha, basta realizar o download Aqui
- MongoDb: Caso tambm no tenha, basta realizar o download Aqui
p.s.: por padro j estou deixando a conexo de dados do Cloud: MLab, para facilitar todos vocs. Mas, caso queiram testar via MongoDb, bastam baixar e descomentar a connection criada nos arquivos contidos na pasta: 'config'.
Instalando as Dependncias (via Windows):
Abre o cmd (caso esteja utilizando o Windows) e digite a path do seu projeto
cd "C:\Users\NomeDoComputador\Documents\..."
Depois, quando estiver na pasta do projeto, basta digitar no cmd a seguinte instruo: (dentro do src)
npm install
Ao digitar a instruo acima, automaticamente ele ir baixar todas as dependncias listadas e definidas no arquivo package.json:
-
node_modules- que contm os packages do npm que precisar para o projeto.
Instalao dos Programas via Linux:
Estarei disponibilizando os links onde explicam como baixar:
Padro das Rotas Criadas:
Procurando seguir o padro e design das API's, segue abaixo as URI's das rotas a serem desenvolvidas:
obs.: api de exemplo atravs do site: https://jsonplaceholder.typicode.com
| ROTA | HTTP(Verbo) | Descrio | Links (via PostMan) |
|---|---|---|---|
| /planets | GET | Selecionar Todos os Planetas | GET: http://localhost:8000/api/planets |
| /planets | POST | Criar um Post | POST: http://localhost:8000/api/planets |
| /planets/:id | GET | Selecionar Por Id | GET: http://localhost:8000/planets/:id |
| /planets/:nome | GET | Selecionar Por Nome | GET: http://localhost:8000/planets/:name |
| /planets/:id | PUT | Atualizar Por Id | PUT: http://localhost:8000/planets/:id |
| /planets/:id | DELETE | Excluir Por Id | DELETE: http://localhost:8000/planets/:id |
Executando a Aplicao
Primeiro, voc precisar abrir um terminal na sua mquina e iniciar o MongoDb. Basta digitar na tela do cmd o seguinte comando:
mongod
Depois, abre um outro terminal, para iniciar a aplicao. Para isso, basta iniciar o server para o projeto ser executado localmente. (via nodemon)
npm start
Caso o MongoDb esteja devidamente instalado em sua mquina, ele iniciar o servio mostrando que a port 27017 foi iniciada.
Agora, abre a pgina da aplicao em http://localhost:8000/api. E pronto a aplicao ser executada de maneira local na sua mquina.
Se tudo der certo, dever apresentar a seguinte mensagem:
Bem Vindo(a) a API da B2WAds
Executando os Testes:
Basta executar o comando: (dentro da pasta src)
- Para Testes de Integrao:
> npm run test:integration
- Para Testes de Unidade:
> npm run test:unit
documentao em desenvolvimento