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.