2. Product API
Create a RESTful API for a store. The API should have two main resources: product
and order
.
flowchart LR
subgraph api [Trusted Layer]
direction TB
gateway --> account
gateway --> auth
account --> db@{ shape: cyl, label: "Database" }
auth --> account
gateway --> exchange
gateway e5@==> product:::red
gateway e6@==> order
product e2@==> db
order e3@==> db
order e4@==> product
end
exchange --> 3partyapi@{label: "3rd-party API"}
internet e1@==>|request| gateway
e1@{ animate: true }
e2@{ animate: true }
e3@{ animate: true }
e4@{ animate: true }
e5@{ animate: true }
e6@{ animate: true }
classDef red fill:#fcc
click product "#product-api" "Product API"
Attention
To consume the API, the user must be authenticated.
Product API
The API should have the following endpoints:
POST /product
Create a new product.
GET /product
Get all products.
GET /product/{id}
Get a product by its ID.
Additionals
Additional features are welcome, such as:
- Search products by "like" name;
- Authorization by role (admin, user):
- Admin can create, update, and delete products;
- User can only create orders;
- Input validations;
- Error handling.
Nice to have
- Observability (metrics, logs), see Prometheus and Grafana;
- Database In-Memory (suggestion: Product microservice), see Redis;
- Swagger documentation, see SpringDoc.
Entrega
Individualmente, cada aluno deve criar um repositório no GitHub, com a documentação em MkDocs dos exercícios realizados e também com o projeto e entrega o link via BlabkBoard. Na documentação publicada deve constar:
- Nome do aluno e grupo;
- Documentação das atividades realizadas;
- Código fonte das atividades realizadas;
- Documentação do projeto;
- Código fonte do projeto;
- Link para todos os repositórios utilizados;
- Destaques para os bottlenecks implementados (ao menos 2 por indivíduo);
- Apresentação do projeto;
- Vídeo de apresentação do projeto (2-3 minutos);
Um template de documentação pode ser encontrado em Template de Documentação.