Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/glaucia86/lambda-crud-api-node

Challenge da empresa Lambda3
https://github.com/glaucia86/lambda-crud-api-node

chai expressjs javascript mocha mongodb nodejs tdd

Last synced: 12 days ago
JSON representation

Challenge da empresa Lambda3

Awesome Lists containing this project

README 

        
# Challenge: Lambda3 - RESTFul Api em Node.Js com TDD (Mocha & Chai)



Challenge da empresa Lambda3 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.



## Recursos Utilizados no Desenvolvimento:



- Node.Js;

- Express.Js

- MongoDb & MLab;

- Code Metrics; (análise de desenvolvimento do codigo)

- Visual Studio Code;

- Json data (para retornar os dados);

- PostMan (testar a API criada);

- TDD (Mocha & Chai);



## Testando a Aplicação no Postman:



Caso queira testar as API's criadas no projeto, primeiro baixe o [Postman](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop).

Depois de realizar o download do Postman, basta agora realizar os passos abaiaxo para 

poder testar cada API criada!



## Executar Localmente



Caso você deseja executar o projeto na sua máquina local, basta seguir os passos abaixo:



## Começando...



Para começar, você deve simplesmente clonar o repositório do projeto na sua máquina e instalar as dependências.



### Pre-Requisitos



Antes de instalar as dependências no projeto, você precisa já ter instalado na sua máquina:



* **Node.Js**: Caso não tenha, basta realizar o download [Aqui](https://nodejs.org/en/)

* **MongoDb**: Caso também não tenha, basta realizar o download [Aqui](https://www.mongodb.com/download-center#community)



p.s.: o MongoDb caso você decida conectar a sua base de dados de maneira local. Caso não, basta usar 

a base de dados do MongoDb em Cloud:



* [MLab](https://mlab.com/)



**p.s.: por padrão já estou deixando a conexão de dados do Cloud: MLab, para facilitar todos vocês. Mas, caso queiram testar via MongoDb, bastam baixar e descomentar a connection criada nos arquivos contidos na pasta: 'config'.**



### Instalando as Dependências (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 instrução: **(dentro do src)**



```

npm install

```



Ao digitar a instrução acima, automaticamente ele irá baixar todas as dependências listadas e definidas no arquivo package.json:



* `node_modules` - que contêm os packages do npm que precisará para o projeto.



## Instalação dos Programas via Linux:



Estarei disponibilizando os links onde explicam como baixar:



- Node.Js: [AQUI](https://nodejs.org/en/download/package-manager/)

- MongoDb: [AQUI](https://docs.mongodb.com/v3.0/administration/install-on-linux/)



## Padrão das Rotas Criadas: 



Procurando seguir o padrão e design das API's, segue abaixo as URI's das rotas a serem desenvolvidas:



obs.: api de exemplo através do site: https://jsonplaceholder.typicode.com



 ROTA                      |     HTTP(Verbo)   |      Descrição                |      Links (via PostMan)                 

-------------------------  | ----------------- | ---------------------         | ---------------------------------------- 

/posts                     |       GET         | Selecionar Todos os Posts     | GET:    http://localhost:8000/posts      

/post                      |       POST        | Criar um Post                 | POST:   http://localhost:8000/post

/post/:post_id             |       GET         | Selecionar Por Id             | GET:    http://localhost:8000/post/:id

/post/:post_id/            |       PUT         | Atualizar Por Id              | PUT:    http://localhost:8000/post/:id   

/post/:post_id/            |       DELETE      | Excluir Por Id                | DELETE: http://localhost:8000/post/:id



### Executando a Aplicação



Bom, agora na mesma tela do cmd, basta iniciar o server para o projeto ser executado localmente.



```

node server.js

```



Depois, você precisará abrir um outro terminal na sua máquina e iniciar o MongoDb. Basta digitar na tela do cmd o seguinte comando:



```

mongod

```



Caso o MongoDb esteja devidamente instalado em sua máquina, ele iniciará o serviço mostrando que a port 27017 foi iniciada.



Agora, abre a página da aplicação em `http://localhost:3000/api`. E pronto a aplicação será executada de maneira local na sua máquina.        



p.s.: no projeto, disponibilizei 2 maneiras de realizar a conexão de dados com o MongoDb através do Mongoose:



* **De maneira local**: utilizando o MongoDb;

* **De maneira em cloud**: utilizando o MLab;



## Executando os Testes:



Basta executar o comando: **(dentro da pasta src)**



```

> npm test



```



Fiquem à vontade em usar ou até mesmo testar ambas as conexões!! :)  

Quaisquer dúvidas ao testar as api's via postman é só falar. Já disponibilizei dois cadastrados no MLab (para que possam testar o 'Listar')



**sempre no formato: x-wwwform-urlencoded**



```

[

    {

        "_id": "59821330eacea81b34c74d64",

        "title": "Flamengo - Campeonato Brasileiro 2017",

        "name": "Glaucia Lemos",

        "email": "[email protected]",

        "body": "Jogador não está nos planos e tem rejeição nos bastidores da Gávea. Rubro-Negro evita descartá-lo de forma oficial neste momento - não quer ir contra opinião da torcida de forma tão enfática"

    },

    {

        "_id": "59821472eacea81b34c74d69",

        "title": "Futebol Internacional - Neymar",

        "name": "Globo Esporte",

        "email": "[email protected]",

        "body": "Messi se despede de Neymar com vídeo de retrospectiva: Foi um prazer enorme"

    }

]



```