SuperAPI AI 工具集

api-docs-generator

编程与开发

查看项目

更新于 10-15 21:04

技能介绍

用途:从源码或控制器代码自动生成 API 文档,适用于 REST API 与 GraphQL 的文档编写,也可用于生成客户端调用示例。

主要能力:可输出 OpenAPI/Swagger 3.0 规范、Markdown(适配 GitHub/GitLab)、交互式 HTML(Swagger UI)、可导入的 Postman Collection,以及 GraphQL Schema 文档;支持生成多语言代码示例、OAuth/JWT/API Key 等认证说明、错误码参考、速率限制信息与 API 版本管理。

支持框架:REST 方面包括 Express.js、FastAPI、Flask、Django REST Framework、Spring Boot、ASP.NET Core、Gin/Echo、Rails、Laravel;GraphQL 方面包括 Apollo Server、GraphQL Yoga、Hasura。

使用方式:以自然语言提出需求,例如指定某个端点、整个控制器或整个项目,并说明输出格式与包含内容。示例:为 GET /api/users/{id} 生成文档,格式 OpenAPI 3.0;或为 Express.js 项目生成 OpenAPI 3.0 + Swagger UI,包含认证流程、全部端点、数据模型与错误码。也可自定义输出格式、认证方式、代码示例语言、错误码、限流信息与版本号。

限制:资料未提供安装命令、依赖要求、收费与价格信息,也未说明具体运行环境与平台支持范围;实际生成效果取决于所提供源码的完整程度。