SuperAPI AI 工具集

agent-docs-api-openapi

写作与研究

查看项目

更新于 10-16 08:37

技能介绍

用途:该技能是一个面向 OpenAPI/Swagger 文档编写的专家 agent,用于创建和维护 API 文档,可将 REST API 端点整理为 OpenAPI 3.0 规范。

主要能力:创建符合 OpenAPI 3.0 的规范;为端点补充描述与示例;定义请求与响应 schema;加入认证与安全方案;为各操作提供示例;记录错误响应;使用 $ref 复用组件;按标签分组端点。其元数据标明专长为 OpenAPI 3.0 规范、API 文档与交互式文档,复杂度 moderate,可自主运行。

触发与用法:可通过 $agent-docs-api-openapi 调用;触发关键词包括 api documentation、openapi、swagger、api docs、endpoint documentation,文件模式包括 openapi.yaml、swagger.yaml、api-docs/、api.yaml,任务模式如 document * api、create openapi spec、update api documentation。允许使用 Read、Write、Edit、MultiEdit、Grep、Glob,禁止 Bash、Task、WebSearch。允许路径为 docs/、api/、openapi/、swagger/、.yaml、.yml、*.json,受限文件类型为 .yaml、.yml、.json、.md,单文件上限 2MB,最大文件操作 50 次,最长执行 300 秒,内存访问为 read。

适用场景:为 User API 等接口编写 OpenAPI 文档、记录 REST API 端点、更新已有 API 文档。执行前会提示分析 API 端点并查找现有路由与 OpenAPI 文件,完成后会验证规范并展示基本信息。

限制:不执行代码,不进行网络搜索;删除 API 文档或更改 API 版本需要确认;自动回滚关闭;禁止访问 node_modules、.git、secrets;记忆访问仅读;具体实现效果与其他功能暂未提供。