Projeto de API desenvolvido para simular cadastro de clientes e favoritos de produtos utilizando a Fake Store API.
- Node.js
- Express.js
- Sequelize ORM
- PostgreSQL
- Docker e Docker Compose
- Swagger (para documentação da API)
Siga os passos abaixo para subir o ambiente completo utilizando Docker:
- Clone o repositório:
git clone https://github.com/frederycomiguel/Aiqfome-API-Challenge
cd aiqfome-api
- Suba os containers com Docker Compose:
docker-compose up --build
- Acesse a aplicação:
- API: http://localhost:3000
- Swagger Docs: http://localhost:3000/api-docs
- `src/models/` → Definições das models Sequelize
- `src/routes/` → Rotas da API (clientes e favoritos)
- `src/swagger.js` → Configuração da documentação Swagger
- `src/index.js` → Arquivo principal que inicia o servidor
Após subir o projeto, a documentação Swagger estará disponível em:
http://localhost:3000/api-docs
Você poderá testar os endpoints diretamente por lá.
- Subir ambiente:
docker-compose up --build
- Derrubar ambiente:
docker-compose down
- Ver logs:
docker logs -f nome_do_container
Método | Rota | Descrição |
---|---|---|
POST | `/api/clients` | Cadastrar cliente |
GET | `/api/clients` | Listar clientes |
PUT | `/api/clients/{id}` | Atualizar cliente |
DELETE | `/api/clients/{id}` | Deletar cliente |
POST | `/api/clients/{id}/favorites` | Adicionar produto aos favoritos |
GET | `/api/clients/{id}/favorites` | Listar favoritos de um cliente |
DELETE | `/api/clients/{id}/favorites/{productId}` | Remover produto dos favoritos |
- Docker
- Docker Compose EOF