OpenAPI

对 OpenAPI 规格做兼容性检查,提前识别破坏性接口变更。

OpenAPI

对于 API 平台团队,OpenAPI 的 breaking change 往往直接影响客户端。Cogna 可以在发布前自动识别风险。

推荐配置

profile: openapi-spec
inputs:
  include:
    - "**/*.yaml"
    - "**/*.yml"
    - "**/*.json"

常见高风险变化

  • 删除已有 endpoint
  • 删除响应状态码
  • 参数从可选改为必填
  • schema 收窄导致旧请求不再合法

使用步骤

cogna build
cogna diff
cogna check

相关文档