01. DADOS GERAIS
Produto: | |
---|
Linha de Produto: | |
---|
Segmento: | |
---|
Módulo: | TOTVS Transmite |
---|
Função: | Não Há |
---|
País: | Brasil |
---|
Ticket: | Não Há |
---|
Requisito/Story/Issue (informe o requisito relacionado) : | DSERTSS3-5516 |
---|
02. SITUAÇÃO/REQUISITO
- Criar documentação das API's utilizadas na integração com o Compras, de forma que o usuário tenha informações suficientes para consumir os endpoints e processar o retorno.
03. SOLUÇÃO
- Configuração do Swagger para documentar as diferentes versões da API com os endpoints utilizados na integração com o Compras. Essa documentação inclui:
- Descrição dos endpoints e propósito no processo de integração com o Transmite;
- Possibilidade de consumo da API através da própria interface visual do Swagger;
- Detalhes dos parâmetros de entrada e informações dos schemas, bem como exemplo do JSON de envio e resposta da API;
- Informações sobre os Status Code retornados pela API e recomendações a serem seguidas em cada caso;
04. DEMAIS INFORMAÇÕES
05. ASSUNTOS RELACIONADOS