Histórico da Página
...
A tag principal desse bloco é 'program'
e referencia o arquivo *.p que precisar ser documentado, ou seja, no exemplo abaixo o arquivo *.yml validará o arquivo PROGRESS
'pedido.p'.
Bloco de código | ||
---|---|---|
| ||
swagger: "2.0" info: description: "Este é um exemplo de aplicação de API no modelo Totvs-rest para um modelo de negocio referente a 'Pedidos'" version: "1.0.0" title: "Exemplo API Totvs-REST" basePath: "/tstUn/v1/" program: pedido.p tags: - name: "servicoConsultaPedido" description: "Exemplopo de chamada para modelo de negócio 'Pedido'" externalDocs: description: "Mais informações em:" url: "http://tdn.totvs.com" schemes: - "http" paths: /tstUniApiDatasul: |
...
No bloco de código PROGRESS
abaixo (pedido.p), estão inicialmente as chamadas das includes progress
referente a padronização das ações dos métodos HTTP
. Este trecho não é correspondente ao YAML acima, porém complementa a construção da API TOTVS-REST.
Bloco de código | ||
---|---|---|
| ||
{utp/ut-api.i} {utp/ut-api-action.i pi-get GET /~* } {utp/ut-api-action.i pi-send GET /~*/SEND by=email,address=~* } {utp/ut-api-action.i pi-post POST /~* oi=1} {utp/ut-api-action.i pi-put PUT /~* } {utp/ut-api-action.i pi-delete DELETE /~* } {utp/ut-api-notfound.i} |
...
A validação neste método acontece na declaração da procedure progress, na tag 'procedure
', que neste caso é 'pi-get'.
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas