Intégrer automatiquement un grand nombre de documents d’API dans un environnement MSA

 (techblog.lycorp.co.jp)
12 points par yechoi 2024-04-29 | 1 commentaires | Partager sur WhatsApp
  • Dans un environnement MSA, un problème se pose : il y a autant de spécifications d’API que de domaines de service
  • Pour résoudre ce problème, réflexion sur la manière de :
    • afficher, dans un environnement MSA, les documents de différents services sur une seule URL ;
    • générer automatiquement les pages de documentation d’API
  • Définition des exigences et architecture
  • Outils et spécifications utilisés pour l’intégration de la documentation d’API
  • Mise en œuvre de l’intégration de la documentation d’API
    • travail de code de base pour satisfaire la spécification OpenAPI
    • extraction de la documentation d’API au format JSON
    • hébergement web avec GitHub Pages
    • automatisation avec GitHub Actions
  • Comment appliquer l’intégration de la documentation d’API dans un environnement multi-référentiels

À lire aussi

1 commentaires

 
elijah17 2024-04-30

Pour résoudre un problème similaire, nous développons une application web open source qui collecte la documentation d’API Swagger et l’affiche à nouveau via Swagger UI. https://github.com/stray-cat-developers/giant-otter
Si vous vous posez un problème similaire, cela peut valoir le coup de l’essayer.