Como integrar automaticamente um grande volume de documentação de API em um ambiente MSA

 (techblog.lycorp.co.jp)
12 pontos por yechoi 2024-04-29 | 1 comentários | Compartilhar no WhatsApp
  • Em um ambiente MSA, surge o problema de haver uma especificação de API para cada domínio de serviço
  • Para resolver esse problema,
    • considerar como exibir a documentação de vários serviços em um único URL em um ambiente MSA.
    • e como gerar automaticamente as páginas de documentação de API
  • Definição de requisitos e arquitetura
  • Ferramentas e especificações usadas na integração da documentação de API
  • Implementação da integração da documentação de API
    • Trabalho básico de código para atender à especificação OpenAPI
    • Extração da documentação de API em formato JSON
    • Hospedagem web com GitHub Pages
    • Automação com GitHub Actions
  • Como aplicar a integração da documentação de API em um ambiente com múltiplos repositórios

Leituras relacionadas

1 comentários

 
elijah17 2024-04-30

Para resolver um problema parecido com esse,
estamos criando um aplicativo web que coleta documentação de API do Swagger e a exibe novamente em uma Swagger UI, e o disponibilizamos como open source.
https://github.com/stray-cat-developers/giant-otter
Se alguém estiver passando por uma preocupação semelhante, talvez valha a pena experimentar.