SuperAPI AI 工具集

rest-api-doc

编程与开发

查看项目

更新于 10-15 22:19

技能介绍

用途:为一批 REST API 端点生成清晰、一致、专业的接口参考文档,适合需要 API 参考文档、端点说明或 HTTP 接口描述的场景。

主要能力:每个端点覆盖 HTTP 方法、路径、摘要、鉴权方式、路径/查询/请求体参数、响应结构与状态码,并给出完整请求与响应示例。支持三种输出格式:Markdown(默认,适合 README、GitHub wiki)、HTML(独立可浏览页面)、OpenAPI 3.0 YAML(机器可读,适合工具集成)。多端点时按统一顶层结构组织,含 Base URL、鉴权说明、速率限制(若已知)与目录。

使用方式:输入可为原始端点列表、路由/控制器代码、curl 示例、OpenAPI YAML/JSON 或纯文字描述。技能会依据命名约定、HTTP 动词和上下文推断缺失细节,并显式标注假设。输出默认写入 /mnt/user-data/outputs/api-docs.md(或 .html / openapi.yaml),并通过 present_files 呈现。格式不明确时默认 Markdown。

推断规则:若集合中某端点使用鉴权则默认全部需要;默认包含 400、401、404、500 错误响应;列表型 GET 补充分页参数与分页响应结构;ID 默认字符串;时间戳用 ISO 8601。所有非显然推断处会加 ⚠️ 假设提示供核对。

限制:文档未提供具体收费、价格、平台支持或效果数据;生成质量依赖输入完整度,缺失信息以假设标注而非编造。