MSA環境の多数のAPIドキュメントを自動で統合する

 (techblog.lycorp.co.jp)
12 ポイント 投稿者 yechoi 2024-04-29 | 1件のコメント | WhatsAppで共有
  • MSA環境では、サービスドメインの数だけAPI仕様が増えるという問題が発生
  • この問題を解決するために、
    • MSA環境で複数のサービスドキュメントを1つのURLで表示し、
    • APIドキュメントページを自動生成する方法を検討
  • 要件定義とアーキテクチャ
  • APIドキュメント統合に使用したツールと仕様
  • APIドキュメント統合の実装
    • OpenAPI仕様を満たすための基本コード作業
    • APIドキュメントをJSON形式で抽出
    • GitHub PagesでWebホスティング
    • GitHub Actionsを使った自動化
  • マルチリポジトリ環境でAPIドキュメント統合を適用する方法

関連記事

1件のコメント

 
elijah17 2024-04-30

同様の問題を解決するために、
Swagger API docを収集し、それを再びSwagger UIで表示するWebアプリケーションを作成してオープンソースとして公開しています。
https://github.com/stray-cat-developers/giant-otter
もし同じような悩みをお持ちの方は、使ってみるのもよさそうですね