SuperAPI AI 工具集

openapi

编程与开发

查看项目

更新于 10-15 22:38

技能介绍

用途:该技能用于处理 OpenAPI 规范(OAS 3.x)文档,适用于新建规范文件、描述 HTTP API 端点、定义请求/响应 Schema、配置安全(OAuth2、API Key、JWT)、校验已有文档以及从规范生成客户端/服务端代码。当前版本为 OpenAPI 3.2.0(2025 年 9 月)。

主要能力:文档根对象必须包含 openapi 与 info 字段;支持 servers、paths、components、security、tags 等结构,可定义路径项、操作、参数、请求体、响应与复用组件。Schema 支持 allOf 组合、oneOf 多态与 discriminator、可空类型(3.1+ 使用类型数组)。参数覆盖 path、query、querystring、header、cookie 位置,并支持 simple、form、matrix、label、deepObject 等序列化风格。安全方案包含 API Key、HTTP Bearer(JWT)与 OAuth2,支持全局或按操作覆盖。通过 $ref 可引用同文档或外部文件,避免重复。

使用方式:入口文件名建议 openapi.json 或 openapi.yaml,JSON 与 YAML 等价,字段名区分大小写。编写时建议为所有操作设置唯一的 operationId,用 $ref 复用组件,补充 description(支持 CommonMark),定义所有可能的响应码,为复杂 Schema 提供示例,用 tags 分组,废弃操作用 deprecated: true 标记,info.version 采用语义化版本。

限制与注意事项:不得省略 openapi 和 info 字段;不得重复 operationId;Reference Object 不能与同级属性混用;path 参数必须 required: true;新 API 不应使用隐式 OAuth2 流程(已废弃);受保护端点勿忘配置 security。常见校验错误包括缺失必填字段、operationId 无效、路径参数与路径不匹配、重复路径模板、$ref 无效等。文档未提供具体的校验命令或工具链安装方式,暂未提供。