Esse é um exemplo simplês de uma Rest API CRUD de usuários. O projeto é conteinerizado em docker, fazendo uso do docker-compose, não só para rodar a instância da aplicação, bem como PostgreSQL e PGAdmin.
Nesse tópico abordaremos como instalar e preparar o ambiente local.
Para rodar a aplicação é necessário:
- Docker: https://docs.docker.com/get-docker/
- Docker-compose: https://docs.docker.com/compose/install/
- Clone o repositório
git clone https://github.com/Gcunhaa/crud-nodejs.git
- Construa a imagem dos containers
cd crud-nodejs && docker-compose build
Estamos prontos para rodar!
Para rodar a aplicação basta iniciar o docker-compose
docker-compose upQuando a aplicação começar a rodar, você pode fazer os requests nos endpoints da API http://localhost:8080/api , assim como acessar o banco de dados via o PGAdmin http://localhost:5050
Para rodar os testes unitários basta trocar no arquivo Dockerfile de
#CMD ["npm", "test"]
CMD ["npm", "start"]
para
CMD ["npm", "test"]
#CMD ["npm", "start"]
(Caso queira rodar a aplicação normalmente, basta voltar o arquivo para o estado inicial)
| Método | Endpoint | Descrição |
|---|---|---|
| GET | /users/ | Retorna todos os usuários |
| GET | /users?name=$NOME | Retorna todos os usuários com o devido nome |
| GET | /users/:id | Retorna usuário com o devido ID |
| POST | /users/ | Cria um usuário (Verifique os parametros necessário abaixo da tabela) |
| PUT | /users/:id | Atualiza um usuário (Mesmos parametros do POST) |
| DELETE | /users/:id | Deleta um usuário do DB |
Segue os parametros requiridos no body do request para o método POST e PUT:
{
"name": "Gabriel Cunha",
"birthdate": "2001-02-25",
"zipcode": "00000000",
"acceptedTerms": "true",
"accessCount": "0",
"document": "2685696850"
}Gabriel Salomão Cunha - gsalomaoc@gmail.com