SuperAPI AI 工具集

openapi-spec-writer

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:为新建或已有的 REST API 编写 OpenAPI 3.0/3.1 规范,支持 API 优先设计、契约定义、SDK 生成、交互式文档搭建、响应校验以及从 OpenAPI 2.0(Swagger)迁移到 3.x。

主要能力:编写路径与操作定义、请求/响应 schema、认证方案、服务器配置;使用 JSON Schema 与 OpenAPI 扩展设计可复用组件、多态 discriminator、oneOf/anyOf/allOf 组合、可空类型与默认值;提升文档质量,包括描述与示例、Markdown 描述、错误响应与弃用说明;集成 Swagger UI、Redoc、Spectral 校验、SDK 生成与 Mock 服务器配置。

使用方式:资料未提供具体安装命令或调用步骤,仅说明可与 api-architect、rest-api-design、typescript-pro、github-actions-pipeline-builder 等技能配合使用。示例中给出完整 OpenAPI 3.1 规范写法,涵盖 info、servers、tags、paths、components(securitySchemes、parameters、schemas、responses、examples)以及多态 schema 与 Spectral 规则配置。

适用场景:新 API 规范编写、现有 REST API 文档化、实现前设计 API 契约、生成客户端 SDK、搭建 Swagger UI/Redoc、按 schema 校验响应、Swagger 迁移。

限制:资料未提供收费、价格、平台支持范围、性能或效果数据;未给出安装命令与运行环境要求,相关事实暂未提供。