SuperAPI AI 工具集

openapi-specification

编程与开发

查看项目

更新于 10-16 01:37

技能介绍

用途:面向 REST API 契约,指导 OpenAPI 3.x 规格的设计、校验与维护,覆盖 schema 模式、安全方案、版本管理和代码生成集成。

主要能力与工作流:分为四个阶段。设计阶段先确定资源、操作、资源关系、认证方案与命名/分页/错误格式约定,并给出规格骨架(openapi、info、paths、components)。Schema 阶段在 components/schemas 中复用数据模型,用 $ref 引用共享 schema,用 allOf 组合、oneOf/anyOf 表达多态,为每个 schema 与属性添加示例,显式声明 required,并用 type: ["string", "null"](3.1)或 nullable: true(3.0)处理可空字段。校验阶段在提交前运行 lint,推荐命令:spectral lint openapi.yaml;也可用 redocly lint openapi.yaml 或 swagger-cli validate openapi.yaml。集成阶段基于通过校验的规格生成文档(Redoc、Swagger UI、Stoplight)、客户端 SDK(openapi-generator、autorest、orval)、服务端桩(openapi-generator 服务端模板)与契约测试(Schemathesis、Dredd、Prism)。

适用场景:从零创建规格、为现有规格新增端点或 schema、审查契约正确性、设置代码生成、为大型 API 设计可复用组件、实现安全方案、管理版本与弃用。

限制与注意:资料未提供具体许可、收费或平台支持信息。反模式包括内联 schema、单文件混用多版本、用 200 表示创建操作、省略 4xx/5xx 错误 schema、无理由使用 additionalProperties: true。质检清单要求所有路径有 operationId、方法语义正确、每个响应有描述与 schema、定义安全要求、提供请求响应示例、统一命名、为下线端点设置弃用字段,且 linter 零错误。