... | ... | @@ -59,15 +59,33 @@ Na sprint 0, foi feito um questionário com o time para quantificar o conhecimen |
|
|
|
|
|
É uma API RESTful construída utilizando Spring Boot. Para a documentação e teste dos endpoints da aplicação, foi utilizado o Swagger. Para a estruturação da aplicação, utilizamos o Layers Pattern (padrão camadas). Contendo três camadas:
|
|
|
|
|
|
* Presentation layer: fornece os endpoints da aplicação. Possui o controller, Data Transfer Objects (DTOs) e entidades.
|
|
|
- **Presentation layer**: fornece os endpoints da aplicação. Possui o controller, Data Transfer Objects (DTOs) e entidades.
|
|
|
|
|
|
* Business logic layer: possui toda a lógica da aplicação, como cálculos, transformações de dados e processamento de dados. Está presente no pacote service.
|
|
|
- **Business logic layer**: possui toda a lógica da aplicação, como cálculos, transformações de dados e processamento de dados. Está presente no pacote service.
|
|
|
|
|
|
* Data access layer: fornece toda a comunicação com o banco de dados, criando, buscando, atualizando e deletando dados do banco. Na nossa aplicação esta camada está presente no pacote repository.
|
|
|
- **Data access layer**: fornece toda a comunicação com o banco de dados, criando, buscando, atualizando e deletando dados do banco. Na nossa aplicação esta camada está presente no pacote repository.
|
|
|
|
|
|
<h3 id="back-end-mods-sis">Módulos do Sistema</h3>
|
|
|
|
|
|
TBD
|
|
|
- **config**: contém as configurações de cors e do Swagger.
|
|
|
|
|
|
- **controller**: é o ponto de entrada do backend, onde ficam definidos os endpoints da aplicação, ou seja, os caminhos após o endereço do servidor como `/user` e qual o tipo de chamada o endereço irá receber `GET`, `POST`, `PUT` ou `DELETE`.
|
|
|
|
|
|
- **dto**: possui os objetos utilizados para transportar dados entre as camadas.
|
|
|
|
|
|
- **entity**: possui os mapeamentos para a tabela do banco de dados.
|
|
|
|
|
|
- **enums** : possui as enumerações utilizadas nas `DTOS` ou entidades.
|
|
|
|
|
|
- **message**: centraliza todas as mensagens que são enviadas ao frontend.
|
|
|
|
|
|
- **repository**: centraliza toda a comunicação com o banco de dados, passando os parâmetros adequados para as funções desejadas.
|
|
|
|
|
|
- **security**: define configurações de acesso aos endpoints e a autenticação de usuários cadastrados.
|
|
|
|
|
|
- **service**: centraliza todas as nossas regras de negócio, utilizando o `repository` para fornecer os dados do banco e realizar as validações.
|
|
|
|
|
|
- **util**: possui classes que tem métodos que são utilizados em diversos services, como por exemplo, o Validations.java, que contém validações de campos de um objeto. Nessa camada também ficam as exceptions personalizadas e os handlers dessas exceptions.
|
|
|
|
|
|
### Diagrama de Fluxo
|
|
|
|
... | ... | |