API文档生成工具

index.js - HTTP API文档

生成时间: 2026-01-31T14:21:14.803Z 源文件: index.js API端点数量: 2

HTTP API 文档分析

检测到的API端点

HTTP方法 路由路径 描述 请求参数 响应格式 状态码
ALL /http-api-doc/scan-and-generate 扫描并生成HTTP API文档
target_path (可选, 默认"."): 扫描目标路径
output_dir (可选, 默认"api_docs"): 输出目录		 JSON格式:
- ret: boolean, 操作是否成功
- msg: string, 操作结果消息
- data: object, 包含处理结果详情		 200: 成功
400: 参数错误

路由分组

此文件仅包含一个API路由分组：HTTP API文档生成

中间件使用情况

  1. urlParser: 用于解析请求URL的中间件（在路由定义中指定）

请求参数说明

路径参数

无路径参数

查询参数/请求体参数

  • target_path (string, 可选): 要扫描的Node.js文件路径，默认为当前目录
  • output_dir (string, 可选): API文档输出目录，默认为"api_docs"

响应格式说明

成功响应示例

{
  "ret": true,
  "msg": "HTTP API文档生成完成，成功: 5个，失败: 0个",
  "data": {
    "total": 5,
    "success": 5,
    "failed": 0,
    "results": [
      {
        "file": "relative/path/to/file.js",
        "success": true,
        "message": "HTTP API文档生成成功",
        "docFile": "api_docs/relative/path/to/file_api.md",
        "apiEndpoints": {
          "fileName": "file.js",
          "endpoints": [...],
          "totalEndpoints": 3,
          "hasRoutes": true
        }
      }
    ],
    "output_dir": "api_docs"
  }
}

错误响应示例

{
  "ret": false,
  "msg": "用户ID不能为空"
}

功能说明

此API端点用于自动化扫描Node.js项目中的HTTP API路由，并生成相应的API文档。它会：

  1. 扫描指定目录下的所有.js文件
  2. 识别Express.js、Koa、Fastify等框架定义的路由
  3. 提取路由信息（方法、路径、参数等）
  4. 调用AI分析代码并生成Markdown格式的API文档
  5. 将文档保存到指定输出目录