用途:为编写和改进 OpenAPI 规范提供约定与经验指引,覆盖规范本身未涉及的风格与灰色地带。适用于新建规范、优化操作命名与组织、表达复杂数据类型、处理文件上传/流式/SSE,以及让规范更利于代码生成。
主要能力与约定:操作 ID 用小写加下划线、resource_action 形式(如 users_list、users_get、users_create),避免自动生成的名称;组件名用 PascalCase(如 UserProfile);标签用小写连字符(如 user-management)。描述使用 CommonMark,要求具体可执行。优先使用复数 examples 并命名示例,而非单个 example。
复用:多操作共用的 schema、通用参数、通用响应与安全方案放入 components;操作专属请求体、独特响应形状和一次性参数保持内联,通过 $ref 引用复用组件。
复杂模式:枚举用语义化字符串值,避免数字字符串与含糊缩写;oneOf 表示精确匹配一种并配合 discriminator 与 mapping;allOf 用于组合/继承;anyOf 表示匹配一个或多个。可空类型在 3.1 用 type: [string, "null"],3.0 用 nullable: true;用 required 数组区分可选字段。文件上传用 multipart/form-data 配合 format: binary,JSON 中 base64 用 format: byte。SSE 用 text/event-stream 表达流式响应。
面向 SDK 生成:始终定义 operationId;提供丰富示例;明确必填字段;oneOf 配合 discriminator;记录错误响应,以生成更类型安全、错误处理更完善的 SDK。
限制:资料未给出该技能的具体安装命令、运行方式、收费信息或平台支持范围,暂未提供。