APIコントラクトとイベントチャネル - インターフェースを記録
C4アーキテクチャに紐づくAPIコントラクトとイベントチャネルを記録。仕様、バージョン、関係を追跡。
api-contracts
FileCode
APIコントラクト
APIコントラクトをアーキテクチャモデルに添付
OpenAPI、AsyncAPI、GraphQLスキーマをC4コンテナとコンポーネントに直接添付。
APIコントラクト管理 | Archyl
OpenAPI、AsyncAPI、GraphQLをC4要素に添付。
APIコントラクト管理, OpenAPIアーキテクチャ
TriangleAlert
APIドキュメントがアーキテクチャから分離
APIコントラクトはSwagger UIにあり図は別の場所。
コントラクト変更が利用者を壊す
どのチームがどのAPIを使用しているか不明。
RefreshCw
APIドキュメントが古くなる
リンクされていないOpenAPI仕様は劣化する。
C4要素にコントラクトを添付
スキーマをアップロードまたは貼り付けてリンク。
アーキテクチャと共にバージョン管理
APIコントラクトをC4モデルと共にバージョン管理。
GitBranch
アーキテクチャコンテキストでAPIを閲覧
コンテナをクリックしてコントラクトを表示。
MCPでAPIを照会
AIアシスタントがMCPツールでコントラクトを照会。
OpenAPI, AsyncAPI, GraphQL
主要なAPI仕様形式をサポート。
アーキテクチャにリンクされたAPI
C4モデルのコンテキストでAPIを表示。
GitPullRequestArrow
バージョン管理されたコントラクト
アーキテクチャモデルと共にバージョン管理。
AIで照会可能なAPI
MCPツールでAPIコントラクトにアクセス。
マイクロサービスAPIドキュメント
各マイクロサービスコンテナにOpenAPI仕様を添付。
イベント駆動アーキテクチャ
AsyncAPIでイベントチャネルを文書化。
APIガバナンス
どのコンテナがAPIを公開しているか追跡。