SuperAPI AI 工具集

api-doc-generator

编程与开发

查看项目

更新于 10-15 21:48

技能介绍

用途:从权威工件生成或更新 API 文档,并明确区分已确认事实与推断。来源优先级依次为:已提交的 OpenAPI/Swagger 契约与生成 schema、框架路由定义与注解、请求/响应模型与校验规则、认证/中间件/异常处理与错误目录、集成与契约测试、用户明确授权的运行时观察。来源冲突时应报告不一致,而非静默选择其一。

主要能力:按框架读取对应参考(OpenAPI-first、Spring、FastAPI、NestJS、Express、Gin);对已提交的 OpenAPI 文档可先生成确定性清单:python3 scripts/inventory_openapi.py path/to/openapi.yaml --output docs/api-inventory.md,该脚本除非显式提供 --force,否则拒绝覆盖已有输出。

工作流:1) 检查项目框架、模块、现有契约与文档约定,确定范围;2) 建立端点清单,记录方法路径、操作标识、用途、认证、请求、响应、错误与证据;3) 解析 schema,保留可空、可选、枚举、格式、范围与长度约束,识别分页与列表封装,显式展示递归或多态 schema,示例中脱敏;4) 按仓库既有约定生成文档,无约定则从 assets/templates/ 复制模板写入 docs/ 下建议路径,写入前报告目标及是否已存在;5) 校验路由、字段、状态码与链接,标记未解决冲突与推断字段。

证据标签:已确认:契约、已确认:源码、已确认:测试、推断、待确认。

限制:不得编造示例值、未记录错误码、必填标记或响应字段;未实际运行 API 不得声称运行时验证。完成时报告生成/更新文件、端点数量、所用权威来源、契约与源码不一致、推断字段及因证据不足跳过的端点。