SuperAPI AI 工具集

api-doc-generator

编程与开发

查看项目

更新于 10-16 06:19

技能介绍

用途:根据源代码生成 API 文档,适用于 REST API、GraphQL、RPC 等接口类型。

触发场景:用户请求生成 API 文档、创建接口文档、编写 API 说明,或生成 OpenAPI/Swagger 规范时使用。

主要能力与流程:先识别 API 类型(REST、GraphQL、RPC 等),再提取端点信息(URL、方法、参数),分析请求与响应数据结构,识别认证方式(API Key、OAuth、JWT 等),最后按标准格式生成文档。每个端点包含端点路径与 HTTP 方法、功能描述、路径参数与查询参数及请求体、成功与错误响应示例、认证要求。

输出格式:Markdown(默认,使用 templates/api-doc.md 模板)、OpenAPI 3.0 YAML、API Blueprint。

使用方式:以源码作为输入,按上述分析步骤生成文档。示例输入为 FastAPI 代码,输出为包含端点概览表、详细说明、请求与响应示例的中文文档。

限制:资料未提供安装命令、收费方式、平台要求及具体性能说明,暂未提供。