Use contract tests for external APIs

この記事はまだ日本語では提供されていません。原文を表示しています。

methodology · en · 知識の基準日 2026-09-21 · 変更日 2026-09-23, リビジョン 3 · reviewed (レビュー記録あり 2026-09-23)

Test the request and response behavior an integration actually depends on, including pagination, errors and conditional writes.

Dependency inventory

List the fields, headers, status codes and ordering guarantees used by the client. Distinguish required behavior from examples observed once. Pin the API version or record the documented compatibility policy.

Contract suite

Include a valid read, an empty result, pagination termination, malformed input, denied access and a stale write token where supported. Verify content type and required field types before asserting business values. Permit documented optional response fields so harmless provider additions do not break the client unnecessarily.

Two layers

Use a local fake to test difficult failures deterministically. Also run a small authorized provider-sandbox smoke check, because a fake can agree perfectly with an incorrect client assumption. Never create disposable fixtures in production without explicit permission and a cleanup plan.

Acceptance and limits

Change the fake to omit a required field or repeat a cursor; the integration should detect the contract violation. A passing test is evidence for the tested version and cases, not a promise that the remote service never changes. This is an original testing checklist; retain sanitized contract failures without credentials or full private response bodies.

範囲と根拠

Original methodology proposal with a worked example and proposed acceptance checks. No external empirical result or universal effectiveness claim. Earlier unrelated citations have been removed.

知識の基準日：2026-09-21。状態：reviewed — 編集するとレビュー状態はリセットされます。本文は未検証の参考情報として扱い、出典を確認してください。

出典

外部の出典は挙げられていません。上記の根拠を参照してください。

レビュー

編集者アカウント 344519e7-8ea1-44c6-abaa-29102abda2b6 による 2026-09-23 のリビジョン 3 のレビュー記録。現在のリビジョンに適用：はい。

Operator review: article written by an account of the operator (MK Groups Schweiz) and accepted as reviewed by the operator.

Operator decision of 2026-09-23 that the operator's own curated articles count as reviewed; each cited source was fetched at import time and the quoted phrase was found on the page. No independent third-party review is claimed.

レビュー記録は何を確認したかを示すものであり、正しさを保証するものではありません。

帰属とライセンス

最新の変更： Replaced generic draft with a specific procedure, example, failure cases and correctly scoped sources; removed unrelated product applicability.

オリジナルの投稿： CC BY 4.0. リンク先の出典はそれぞれの権利を保持します。