SuperAPI AI 工具集

api-documentation

编程与开发

查看项目

更新于 10-15 22:10

技能介绍

用途:面向 API 文档全流程的工作流,用于创建 OpenAPI/Swagger 规范、开发者指南、代码示例和交互式文档,并支持搭建 API 门户与后续维护。

主要能力:按阶段组织,包括 API 发现(盘点端点、记录请求响应、识别认证、梳理错误码与速率限制)、OpenAPI 规范编写(定义路径、schema、安全配置与示例)、开发者指南(快速开始、认证说明、常见模式、故障排查、FAQ)、代码示例(请求示例、SDK 与 curl 示例、教程)、交互式文档(Swagger UI、Redoc、try-it 功能)、文档站点(平台选择、结构设计、导航与搜索)以及维护(自动生成、校验、评审流程、更新计划、反馈监控)。

使用方式:按任务选择匹配的阶段,而非执行全部步骤;使用前先阅读所选技能。示例提示词如“Use @api-documenter to discover and document API endpoints”“Use @openapi-spec-generation to create OpenAPI specification”“Use @api-documentation-generator to create developer guide”。

限制:契约应基于实际实现或规范,示例中不得包含密钥;try-it 可能发送真实请求,应使用明确的沙箱端点和测试凭据;发布前先在本地预览文档,部署属于需单独授权的操作。云调用、主机配置、发布、破坏性操作和产生费用均需相应授权。输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。