APIコントラクトとイベントチャネル - インターフェースを記録 | Archyl

C4アーキテクチャに紐づくAPIコントラクトとイベントチャネルを記録。仕様、バージョン、関係を追跡。

APIコントラクトをアーキテクチャモデルに添付

OpenAPI、AsyncAPI、GraphQLスキーマをC4コンテナとコンポーネントに直接添付。

OpenAPI、AsyncAPI、GraphQLをC4要素に添付。

APIコントラクト管理, OpenAPIアーキテクチャ

APIドキュメントがアーキテクチャから分離

APIコントラクトはSwagger UIにあり図は別の場所。

どのチームがどのAPIを使用しているか不明。

リンクされていないOpenAPI仕様は劣化する。

スキーマをアップロードまたは貼り付けてリンク。

APIコントラクトをC4モデルと共にバージョン管理。

コンテナをクリックしてコントラクトを表示。

AIアシスタントがMCPツールでコントラクトを照会。

OpenAPI, AsyncAPI, GraphQL

アーキテクチャモデルと共にバージョン管理。

MCPツールでAPIコントラクトにアクセス。

各マイクロサービスコンテナにOpenAPI仕様を添付。

AsyncAPIでイベントチャネルを文書化。

どのコンテナがAPIを公開しているか追跡。

アーキテクチャと共に生きるAPIコントラクト