| ... | @@ -15,7 +15,7 @@ Aqui serão apresentadas as convenções do código desenvolvido. padrões, docu |
... | @@ -15,7 +15,7 @@ Aqui serão apresentadas as convenções do código desenvolvido. padrões, docu |
|
|
|
|
|
|
|
## Ferramentas de Padronização
|
|
## Ferramentas de Padronização
|
|
|
|
|
|
|
|
Iniciando o projeto, é importante notar que foram aplicadas regras de
|
|
Iniciando o projeto, é importante notar que foram aplicadas regras de:
|
|
|
|
|
|
|
|
- Prettier
|
|
- Prettier
|
|
|
- Conventional Commits
|
|
- Conventional Commits
|
| ... | @@ -64,6 +64,14 @@ TBD |
... | @@ -64,6 +64,14 @@ TBD |
|
|
|
|
|
|
|
### Documentação
|
|
### Documentação
|
|
|
|
|
|
|
|
|
Para documentação foram aplicadas regras de:
|
|
|
|
|
|
|
|
- Swagger
|
|
|
|
|
|
|
|
### **1. Swagger**
|
|
|
|
|
|
|
|
O Swagger é definido como uma aplicação open source que auxilia desenvolvedores nos processos de definir, criar, documentar e consumir APIs REST. Em suma, o Swagger visa padronizar este tipo de integração, descrevendo os recursos que uma API deve possuir, como endpoints, dados recebidos, dados retornados, códigos HTTP e métodos de autenticação, entre outros.
|
|
|
|
|
|
|
### Código
|
|
### Código
|
|
|
|
|
|
|
|
TBD |
|
TBD |
