API Contract - CI/CD用語集の定義

API contract はクライアントとサーバーがどのようにリクエストとレスポンスをやり取りするかを記述する、機械的に検証可能な合意です。

API contract はクライアントとサーバーがどのように通信するかについて合意された仕様で、endpoint、リクエストとレスポンスの形、status code、エラー形式を含みます。CIでは、contract test が deploy 前に実行中のサービスがこの合意をまだ守っているかを検証します。

contract は「APIは動くはず」を pipeline が検証できるものに変えます。contract test は CI で実行され、サービスが consumer の期待から逸脱するのを、その逸脱が本番に到達する前に検出します。

CIで重要な理由

workflow 内の contract test は、producer が consumer の依存するレスポンス形式を変更したときに build を失敗させ、統合の破綻を本番ではなく merge 前に検出します。

関連ガイド