用途:route-to-openapi 扫描源码中的路由/端点定义,自动生成符合 OpenAPI 3.0.3 规范的 RESTful API 文档,输出标准 OpenAPI 规范文件,可导入 Swagger UI 或 Redoc。
主要能力:自动检测框架;提取 HTTP 方法、路径、路径参数(含类型推断)、查询参数(Python 框架)、请求体(FastAPI 的 Pydantic 模型与类型注解)、响应模型(FastAPI 的 response_model)、端点描述(docstring/JSDoc/行内注释),并按源文件模块名自动分组 Tag。支持将各框架路径参数格式转换为 OpenAPI 的 {param} 格式,例如 Flask 的 int:user_id 转为 {user_id} 并标注类型 integer。
支持框架:Python 的 Flask、FastAPI、Django REST Framework(AST 解析);JavaScript/TypeScript 的 Express.js 与 Go 的 Gin、Echo(正则匹配)。
用法示例: python scripts/generate_api_doc.py ./src python scripts/generate_api_doc.py ./src --format yaml --output api-spec.yaml python scripts/generate_api_doc.py ./app --framework flask --title "My API" --version 2.0.0 python scripts/generate_api_doc.py ./routes --server http://localhost:3000 --server https://api.example.com
参数:source_dir(必填,扫描目录);-f/--format(json 或 yaml,默认 json);-o/--output(默认输出到 stdout);--framework(强制指定,跳过自动检测);--title(默认 API Documentation);--version(默认 1.0.0);--description(默认空);--server(可多次指定)。
限制:需 Python 3.8+,仅用标准库,无额外依赖;被扫描项目必须使用上述受支持框架之一。费用、价格、平台与效果等资料暂未提供。