首页/开发/软件测试速查/OpenAPI 契约校验

OpenAPI 契约校验

以 OpenAPI 文档为契约做双向校验:校验实现与文档一致(Dredd、Schemathesis 类工具),同时用文档生成用例;文档与实现漂移时应让测试直接失败而不是默默放过。

软件测试速查开发更新于 2026-10-12

工具示意

工具示意
# 用 OpenAPI 文档生成并执行用例(示意):
schemathesis run https://api.example.com/openapi.json

# Dredd:按文档逐端点回放验证实现一致性:
dredd openapi.yml https://api.example.com
把契约校验放进 CI,文档更新与实现变更同批验证,漂移当天暴露。

易错点

  • 文档与实现不符时以文档为准断言,把实现缺陷判成用例问题
  • 只在发布前校验一次,版本演进中契约静默漂移

数据来源与参考

  • OpenAPI 规范(spec.openapis.org)
  • Schemathesis 文档(schemathesis.readthedocs.io)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌