SuperAPI AI 工具集

api-docs-generator

编程与开发

查看项目

更新于 10-16 00:20

技能介绍

用途:审计 API 端点文档的完整性,生成带参数说明与示例的增强 docstring,补全所有响应码,并为 Pydantic 模型生成示例,弥合自动生成的 OpenAPI 规范与真正可用的 API 文档之间的差距。

主要能力:按阶段工作。阶段一分析端点,盘点路由、HTTP 方法、处理函数、请求/响应模型、查询与路径参数、依赖与现有文档;阶段二审计文档,检查端点描述、参数描述、请求示例、response_model、4xx/5xx 错误响应与标签分组;阶段三生成增强内容,包括 docstring、参数元数据(description、example、ge/le/regex)、模型示例(Field(example=...) 与 model_config 的 json_schema_extra)、错误响应与标签;阶段四输出覆盖率报告与增强代码。

使用方式:需能访问 API 源码(路由定义与模型),并识别框架(FastAPI、Flask、Django REST、Express)。输出格式包含覆盖率汇总表、缺口清单(端点、问题、严重程度)以及增强后的代码片段。

适用场景:FastAPI 端点文档补全、REST API 文档审计、OpenAPI 规范增强、响应码与示例补全。

限制:非 FastAPI 框架需调整模式;处理函数无类型提示时需推断并标注不确定性;大型 API(50+ 端点)需按资源分批并优先处理未文档化与公开端点;由 OpenAPI 生成的代码应在规范层文档化。若 API 设计本身有误、需要从 OpenAPI 生成 SDK,或代码仍属会大幅变动的原型,则不建议生成。参考文件包括 fastapi-patterns.md、example-generation.md、response-codes.md、openapi-enhancement.md。