Cómo integrar automáticamente una gran cantidad de documentación de API en un entorno MSA

 (techblog.lycorp.co.jp)
12 puntos por yechoi 2024-04-29 | 1 comentarios | Compartir por WhatsApp
  • En un entorno MSA surge el problema de que se genera una especificación de API por cada dominio de servicio
  • Para resolver este problema,
    • se buscó una forma de mostrar la documentación de varios servicios en una sola URL dentro de un entorno MSA.
    • y de generar automáticamente la página de documentación de API
  • Definición de requisitos y arquitectura
  • Herramientas y especificaciones usadas para integrar la documentación de API
  • Implementación de la integración de la documentación de API
    • Trabajo básico de código para cumplir con la especificación OpenAPI
    • Extracción de la documentación de API en formato JSON
    • Web hosting con GitHub Pages
    • Automatización con GitHub Actions
  • Cómo aplicar la integración de documentación de API en un entorno de múltiples repositorios

Lecturas relacionadas

1 comentarios

 
elijah17 2024-04-30

Para resolver un problema similar, se está desarrollando una aplicación web de código abierto que recopila la documentación de Swagger API y la vuelve a mostrar mediante Swagger UI. https://github.com/stray-cat-developers/giant-otter Si alguien está enfrentando una preocupación parecida, podría valer la pena probarla.