OpenAPI 规范 2.0（以前称为 Swagger 2.0）定义了用于描述 RESTful API 的 JSON/YAML 格式：路径、操作、参数、响应、架构和安全性。在创建或编辑 Swagger 2.0 规范、验证结构或从中生成代码/文档时使用此技能。 > 该技能基于 2026 年 1 月 30 日生成的 OpenAPI 规范 2.0。 ## 核心参考主题 |描述 |参考 ---|---|--- 格式和结构|文档格式、文件结构、数据类型 | [核心格式和结构]() 固定和图案字段|模式中的固定字段名称与模式字段名称 | [core-fixed-patterned-fields]() 招摇对象|根文档、必填/可选字段、扩展名 | [core-swagger-object]() 信息和元数据|信息、联系方式、许可对象 | [核心信息元数据]() 标签和外部文档 |标签对象、外部文档对象| [core-tags-and-external-docs]() 参考对象| $ref、JSON 指针、同一文档和外部文件引用 | [核心参考对象]() 数据类型和格式|基元、格式表、验证、文件类型 | [核心数据类型和格式]() MIME 类型 |消费/生产，RFC 6838，示例 | [core-mime-types]() HTTP 状态代码 |响应密钥、默认响应、IANA/RFC 7231 | [core-http-status-codes]() 路径模板 |大括号、路径参数、名称匹配 | [核心路径模板]() 标头对象 |响应头定义（类型、格式、项目、验证）| [核心头对象]() 标题对象 |响应标头的容器（名称 → 标头对象）| [核心头对象]() 项目对象 |非主体数组项（参数、标头） | [core-items-object]() 示例对象 |按 MIME 类型划分的响应示例 | [核心示例对象]() ## 路径和操作主题 |描述 |参考 ---|---|--- 路径和操作|路径对象、路径项、操作对象 | [路径和操作]() 路径项 $ref |外部路径定义、冲突行为 | [path-item-ref]() ## 参数和响应主题 |描述 |参考 ---|---|--- 参数|参数位置（路径、查询、标头、正文、formData）| [参数]() 集合格式 | csv、ssv、tsv、管道、multi 及其应用 | [参数集合格式]() 参数定义（重用）|根级参数，通过 $ref | 重用[参数定义重用]() 回应 |响应对象，响应对象| [回复]() 响应定义（重复使用）|根级响应，通过 $ref | 重用[responses-definitions-reuse]() ## 模式和定义主题 |描述 |参考 ---|---|--- 架构和定义|模式对象、定义、组合、多态性 | [架构和定义]() 架构 JSON 架构关键字 | JSON 架构草案 4 子集和 Swagger 特定字段 | [schema-json-schema-keywords]() ## 安全主题 |描述 |参考 ---|---|--- 安全|安全定义、安全方案| [安全]() 安全需求对象|在根/操作、OR/AND 逻辑上应用安全性 | [安全要求对象]() 范围对象 | OAuth2 范围名称 → 描述 | [security-scopes-object]() 基本和 API 密钥 |基本和apiKey安全方案| [security-basic-apikey]() OAuth2 流程 |隐式、密码、应用程序、访问代码和所需的 URL | [security-oauth2-flows]() ## 最佳实践主题 |描述 |参考 ---|---|--- 规范编写 |操作 ID、标签、响应、参数、定义、安全 | [最佳实践规范创作]() ## 高级主题 |描述 |参考 ---|---|--- 供应商扩展 | x- 前缀，值类型（如果允许） | [高级供应商扩展]() 安全过滤|空路径，用于访问控制的空路径项 | [高级安全过滤]() 扩展和 XML |架构属性的 XML 对象 | [advanced-extensions-and-xml]()

OpenAPI 规范 V2

包含技能