2026-05-18 · 约 1 分钟阅读
每次发布前校验 OpenAPI
提前发现缺失 paths、info 或版本字段等契约错误。
OpenAPIAPICI
要点
- 结构校验不能替代响应 schema 测试，但能挡住明显低级错误。
- 每个服务维护一份 canonical spec 并校验同一制品。
为什么要在 CI 校验
损坏的 spec 会导致 codegen、文档站与网关连锁失败。
快速结构检查可避免 paths 缺失等问题上线。
推荐流程
合并分支后将 JSON/YAML 粘贴到 OpenAPI Validator。
通过后使用 HTTP Request 抽查关键路径。
常见问题
会校验响应示例吗？
主要检查顶层结构；示例与状态码请用契约测试补充。
支持 Swagger 2.0 吗？
可做基础结构检查；建议尽量迁移到 OpenAPI 3。