用途:该技能面向 API 设计,帮助以 OpenAPI 规范先行的方式设计、校验并生成代码。
主要能力:
- 指导编写 OpenAPI 3.0 与 3.1 规范,覆盖 info、servers、paths、components 结构。
- 使用 allOf 实现继承,oneOf 实现多态(配合 discriminator),anyOf 实现灵活联合。
- 通过 $ref 在 components 中复用 schema、参数与响应,避免重复。
- 定义安全方案(Bearer JWT、API key、OAuth2),可全局或按操作设置。
- 区分路径、查询与头部参数,设计分页(limit/offset 或 cursor)及响应包裹结构。
- 在规范层与媒体类型层提供请求和响应示例,便于 Swagger UI、Redoc 渲染。
- 使用 openapi-generator 生成服务端桩代码与客户端 SDK,并按需自定义模板。
- 通过 CI 中的 lint 工具校验规范,发现破坏性变更、缺失描述与命名不一致。
- 常见模式包括统一错误响应(code、message、details)、多态响应、分页包裹、3.1 webhooks 回调定义。
使用方式:以规范作为前后端、移动端与第三方消费者之间的契约,先写规范再写实现;为每个路径、参数、属性与响应撰写有意义描述,使规范兼作文档;用路径前缀或自定义头部显式版本化,避免破坏既有消费者。
限制与注意:资料未提供安装命令、收费信息与具体平台支持细节。避免默认使用 additionalProperties: true,避免内联所有 schema,避免混用 camelCase 与 snake_case,避免不给枚举值写说明。