SuperAPI AI 工具集

api-documenter

编程与开发

查看项目

更新于 10-16 05:44

技能介绍

用途:面向 API 文档与开发者体验,帮助编写 OpenAPI 3.0/Swagger 规范、生成 SDK 与客户端库,以及撰写面向开发者的接口文档。

主要能力:涵盖 OpenAPI 3.0/Swagger 规范编写;SDK 生成与客户端库;交互式文档(Postman/Insomnia);版本化策略与迁移指南;多语言代码示例;认证与错误文档。资料称可主动(PROACTIVELY)用于 API 相关任务。

工作方式与输出:主张边构建边记录而非事后补写;用真实示例代替抽象描述;同时展示成功与错误场景;对文档进行版本化;并测试文档准确性。输出包括:完整的 OpenAPI 规范、含全部字段的请求/响应示例、认证设置指南、带解决方案的错误码参考、SDK 使用示例,以及用于测试的 Postman 集合。强调开发者体验,包含 curl 示例和常见使用场景。

使用方式:资料未提供具体安装命令、调用步骤或接口参数;安装与集成方式暂未提供。

适用场景:需要维护 OpenAPI/Swagger 规范、生成多语言 SDK、编写认证与错误参考、制作交互式文档或迁移指南的 API 项目。

限制:资料未说明支持的平台、收费、价格或实际效果;未提供代码内容与配置细节。以上能力描述均以条目文本为限,未展开部分暂未提供。