Zahlreiche API-Dokumentationen in einer MSA-Umgebung automatisch integrieren

 (techblog.lycorp.co.jp)
12 Punkte von yechoi 2024-04-29 | 1 Kommentare | Auf WhatsApp teilen
  • In einer MSA-Umgebung entsteht das Problem, dass es genauso viele API-Spezifikationen wie Service-Domänen gibt
  • Um dieses Problem zu lösen, wurden folgende Ansätze untersucht:
    • In einer MSA-Umgebung verschiedene Service-Dokumentationen unter einer einzigen URL anzeigen.
    • Methoden zur automatischen Erstellung von API-Dokumentationsseiten.
  • Definition der Anforderungen und Architektur
  • Für die Integration der API-Dokumentation verwendete Tools und Spezifikationen
  • Implementierung der Integration der API-Dokumentation
    • Grundlegende Code-Arbeiten zur Erfüllung der OpenAPI-Spezifikation
    • Extraktion der API-Dokumentation im JSON-Format
    • Webhosting mit GitHub Pages
    • Automatisierung mit GitHub Actions
  • So lässt sich die Integration der API-Dokumentation in einer Multi-Repository-Umgebung anwenden

Verwandte Beiträge

1 Kommentare

 
elijah17 2024-04-30

Um ein ähnliches Problem zu lösen, entwickeln wir eine Webanwendung als Open Source und stellen sie öffentlich bereit, die Swagger-API-Dokumentationen sammelt und sie dann wieder über Swagger UI anzeigt. https://github.com/stray-cat-developers/giant-otter
Falls jemand ähnliche Überlegungen hat, könnte es sich lohnen, sie einmal auszuprobieren.