本文共 1246 字，大约阅读时间需要 4 分钟。

使用DocGen插件生成接口文档指南

DocGen 是一款适合国人使用的接口测试工具，能够快速生成接口文档，无需手动操作 Postman，简化了开发流程。以下是使用 DocGen 的详细步骤指南。

1. 安装并配置 DocGen 插件

首先，下载 DocGen 插件：

• 访问 GitHub DocGen 项目仓库。
• 下载完成后，将插件文件重命名为 docgen，并将其放置在你的项目根目录下或其他方便的路径下。

接下来，配置环境变量：

• 打开系统环境变量编辑器，找到路径字段（Path），将 C:\docgen 添加到环境变量中。
• 启动 DocGen 插件，确保其路径正确无误。

2. 从 Postman 导出接口

在 Postman 中完成接口测试后，按照以下步骤导出接口数据：

• 右键点击 Postman 的根目录，选择 Export Collection，将接口数据导出为 JSON 文件，保存为 input-postman-collection.json。

3. 生成接口文档

在 DocGen 的黑窗口中，使用以下命令生成文档：

• 生成 HTML 文档：

  docgen build -i input-postman-collection.json -o generated_api.html

• 生成 Markdown 文档：

  docgen build -i input-postman-collection.json -o generated_api.md -m

• 启动本地服务器（可选）：

  docgen server -f input-postman-collection.json -p 8000

  这将在本地启动一个服务器，方便查看生成的文档。

4. 生成实时文档

通过命令行工具快速查看文档：

• 查看 HTML 文档：

  docgen server -f input-postman-collection.json -p 8000

• 查看 Markdown 文档：

  docgen server -f input-postman-collection.json -p 8000 -m

5. 示例命令操作

以下是实际操作示例：

docgen server -f C:\Users\admin\Desktop\api\api.json -p 8000docgen server -f C:\Users\admin\Desktop\api\api.json -p 8000 -mdocgen build -i C:\Users\admin\Desktop\api\api.json -o C:\Users\admin\Desktop\api\api.htmldocgen build -i C:\Users\admin\Desktop\api\api.json -o C:\Users\admin\Desktop\api\api.md -m

通过以上步骤，您可以轻松生成并查看接口文档，提升开发效率。

转载地址：http://wxxfk.baihongyu.com/