Histórico da Página
...
- Reuso de lógicas, uma vez que ao expor um método ou uma função por exemplo, o código do respectivo não precisa ser duplicado no contexto da solução;
- Centralizar lógica (premissa para coesão) que viabiliza em um único ponto de uma solução o acesso a tal lógica;
- Viabilizar integração com outras aplicações quando se tata de uma integração em “baixo nível”, o que causa demanda de acesso a recursos internos da aplicação.
Para modelar a estrutura da documentação será utilizada a ferramentaSWAGGER
que, neste contexto faz uso do formatoYAML
de serialização de dados.
Semântica dos métodos HTTP
...
Para elucidar a utilização da API Totvs-Rest segue um exemplo de como realizar as chamadas que, por usa vez utiliza o 'SWAGGER
' para gerar a documentação. Assim, o exemplo seguirá sempre o padrão: Bloco 'SWAGGER
' (do arquivo *.yml) seguido de seu bloco 'PROGRESS
' correspondente (do arquivo *.p), nesta sequência. O SWAGGER
Informações | ||||
---|---|---|---|---|
| ||||
O |
...
estilo |
...
APIs |
Para o exemplo prático foi utilizada uma simulação de "Manipulação de Pedidos". Segue Segue abaixo os blocos de códigos documentados:
INFO
No bloco de código (progress) abaixo, então, existe um bloco para documentação do 'SWAGGER
', onde são apresentadas informações principais da aplicação como a descrição da mesma com seu Título e versão e, a URL Base da aplicação.
...