Páginas filhas
  • DEAITOOLS-103 Estudar forma de agrupamento de APIs

Criar os OpenAPIs no formato em que serão entregues ao WSO2

Linha de Produto:

TOTVSEAI

Segmento:

Framework

Módulo:

API

Função:

API Modifier

Situação/Requisito:

Foi identificado que as documentações de API existentes no nosso repositório compartilham "contexts" entre si, sendo que o WSO2 permite apenas um context único por API (Context + Versão).

Viu-se a necessidade de implementar um sistema que realizasse o agrupamento dessas APIs com base na URL específicada no server, e a versão.

Solução/Implementação:

O sistema implementado realiza as seguintes operações:

  • Lê um repositório do GitHub, específicado no arquivo de configurações
  • Agrupa "Paths" e "Components/Parameters" de OpenAPIs que possuam o mesmo conjunto de contexto + chave.
  • Altera descrições do "Info" para informar que aquele arquivo agrupado foi gerado automaticamente
  • Salva todos os arquivos gerados no filesystem OU realiza commit e push para um repositório remoto, dependendo do que foi especificado no arquivo de configurações