能否从Angular Services扫描HTTP请求生成Swagger API文档？

1. ng-openapi-gen（逆向解析适配Angular） #

这款工具常被用于从Swagger生成Angular Services，但也支持逆向扫描Angular的HTTP服务代码，生成标准的OpenAPI（Swagger）文档。

• 操作步骤：
  • 安装依赖：npm install ng-openapi-gen --save-dev
  • 在项目根目录创建配置文件ng-openapi-gen.json，配置扫描路径和输出位置：

    {
      "input": "./src/app/services",
      "output": "./openapi.json",
      "type": "openapi",
      "angular": true
    }
    

  • 执行生成命令：npx ng-openapi-gen
• 它会自动解析Services中HttpClient的get/post/put等调用，提取请求方法、路径、参数及响应类型，生成OpenAPI 3.0格式的文档。

2. swagger-jsdoc + 自定义扫描脚本 #

如果需要更灵活的控制逻辑，可以结合swagger-jsdoc编写Node.js脚本手动扫描代码：

• 安装依赖：npm install swagger-jsdoc fs-extra --save-dev
• 核心思路：
  1. 用fs-extra遍历指定的Services目录
  2. 通过正则或简单语法匹配，提取HttpClient调用中的接口信息（比如请求路径、方法、参数结构）
  3. 利用swagger-jsdoc将提取的信息组装成符合Swagger规范的文档
• 适合需要定制扫描规则的场景，比如适配项目中特殊的HTTP封装写法。

3. TypeScript AST自定义解析工具 #

如果前两种工具无法满足需求，可以基于TypeScript的抽象语法树（AST）实现完全自定义的扫描逻辑：

• 借助typescript包提供的API，解析Service文件的AST节点，精准识别HttpClient的调用语句，提取所有接口细节（请求方法、URL、请求头、请求体结构、响应类型等）
• 手动将提取的信息转换成Swagger规范的JSON/YAML格式
• 优势：能适配项目中所有非标准化的HTTP调用写法，灵活性拉满。

关键注意点 #

• 尽量保持Angular Services中的HTTP请求写法规范，比如统一使用HttpClient、为请求体/响应体定义明确的TypeScript接口，这样工具能更准确地提取信息。
• 自动生成的文档可能需要手动补充接口描述、枚举说明等细节，工具只能提取代码中已存在的结构化信息。

内容的提问来源于stack exchange，提问作者mar.io