SuperAPI AI 工具集

openapi-spec-generation

编程与开发

查看项目

更新于 10-16 08:02

技能介绍

用途:该技能面向 RESTful API,提供创建、维护和校验 OpenAPI 3.1 规范的完整模式。适合从零编写 API 文档、从现有代码生成规范、采用设计优先方式定义 API 契约、校验 API 实现是否符合规范、由规范生成客户端 SDK,以及搭建 API 文档门户。

主要能力:围绕 OpenAPI 3.1 规范的生成与维护,覆盖规范编写、代码到规范的转换、设计优先契约设计、实现与规范的比对校验,以及 SDK 生成和文档门户搭建等场景。

使用方式:先明确目标、约束和所需输入,再应用相关最佳实践并验证结果,给出可执行的步骤与验证方法。若需要详细示例,可打开 resources/implementation-playbook.md 获取更详细的模式与示例。

适用场景:API 文档编写、API 契约设计、规范与实现一致性检查、SDK 生成、文档门户建设。

限制:不适用于与 OpenAPI 规范生成无关的任务,也不适用于该范围之外的领域或工具。资料未提供具体命令、代码示例、收费方式与平台支持等细节。