APIコントラクト

プロデューサーとコンシューマーが遵守することに合意する、APIの形式的な仕様(OpenAPI、gRPC proto、GraphQLスキーマ)。

APIコントラクトとは?

APIコントラクトは、インターフェースを暗黙知からバージョン管理された成果物へと変えます。これにより、クライアントコードの生成、CIでの互換性チェック、コンシューマー駆動契約テストが可能になります。チーム間の連携において、これはアーキテクチャが所有しうる最も効果の高いドキュメントの1つです。

関連用語

  • イベントチャネル — サービスが非同期にパブリッシュ・サブスクライブする、名前と型を持つイベントのストリーム(多くの場合Kafkaトピックなど)。
  • マイクロサービス — アプリケーションを、ビジネス機能を中心に編成された、小さく独立してデプロイ可能なサービスの集合として構造化するアーキテクチャスタイル。

詳しく見る