首页/开发/系统分析与架构设计速查/规范校验与风格检查

规范校验与风格检查

对接口描述文件做自动校验:命名风格、必填字段、错误结构与示例有效性;把团队规范变成可执行规则(如 Spectral 规则集),在流水线里拦截偏差。

规则路径命名、字段大小写、错误结构、版本头等
执行提交与合并时扫描规范文件,输出定位信息
演进规则集版本化,新约定先加规则再全量整改

Spectral 规则片段(YAML)

Spectral 规则片段(YAML)
rules:
  operation-operationId:
    severity: error        # 每个操作必须有 operationId
  path-kebab-case:
    severity: warn         # 路径使用 kebab-case
  error-schema-required:
    severity: error        # 统一错误响应结构
规则要有例外机制与负责人:一刀切的检查会被绕过,失去权威性。

易错点

  • 规则集过严无豁免,团队整体绕过检查
  • 样例数据失效未同步,校验结果不可信

数据来源与参考

  • Stoplight Spectral 文档
  • OpenAPI Specification 3.1
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌