SuperAPI AI 工具集

generate-api-docs

编程与开发

查看项目

更新于 10-16 06:17

技能介绍

用途:为当前已有的 API 端点生成完整文档,输出格式为 OpenAPI/Swagger 规范,或遵循项目自身的文档标准。

主要能力:

  1. API 概述:服务描述与用途、基础 URL 与版本信息、认证与授权要求、速率限制与使用策略。
  2. 端点文档:HTTP 方法与 URL 路径、请求参数(路径/查询/请求体)、请求与响应模式及数据类型、示例请求与响应、可能的错误码与错误信息。
  3. 数据模型:定义全部数据模型与模式,包含字段说明与约束,展示模型之间的关系,并提供示例载荷。
  4. 用法示例:常见使用场景、SDK/客户端库示例、CURL 命令示例、错误处理示例。

使用方式:资料未提供具体安装命令、调用参数或运行步骤,暂未提供。

适用场景:需要为已有接口补齐或规范化文档、生成 OpenAPI/Swagger 描述、统一团队文档风格时使用。

限制:资料未说明支持的框架、语言、平台、收费方式及实际效果,暂未提供;具体能力边界需以实际使用为准。