SuperAPI AI 工具集

openapi-spec-generation

编程与开发

查看项目

更新于 10-15 16:45

技能介绍

用途:为 RESTful API 创建、维护和验证 OpenAPI 3.1 规范,适用于从零编写 API 文档、从现有代码生成规范、设计优先的 API 契约设计、依据规范校验实现、从规范生成客户端 SDK,以及搭建 API 文档门户。

主要能力:提供 OpenAPI 3.1 规范编写的综合模式与最佳实践;在开始前澄清目标、约束和所需输入;应用相关实践并验证结果;给出可执行步骤和验证方式。需要详细示例时可查阅 resources/implementation-playbook.md。

使用方式:仅当任务明确属于上述范围时使用该技能。按其指引澄清需求、应用实践、验证结果并执行步骤;如需更详细的模式与示例,打开配套资源文件。

适用场景:API 文档创建、代码到规范的转换、API 契约设计、实现与规范一致性校验、SDK 生成及文档门户搭建。

限制:不适用于与该技能范围无关的任务,也不适用于需要其他领域或工具的场景。输出不能替代针对具体环境的验证、测试或专家评审。若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。