Ubuntu上Postman的接口文档生成

ubuntu

小樊

2025-08-29 11:40:12

栏目: 智能运维

在Ubuntu上使用Postman生成接口文档，主要有以下两种方法：

使用Postman界面生成：
1. 创建接口集合，添加API请求并为每个请求添加详细描述、参数、请求头和请求体等信息。
2. 为接口生成成功、失败和异常样例。
3. 点击集合的“View in Web”预览文档，或点击“Publish Docs”发布文档获取公开URL。
使用第三方工具生成：
1. 安装docgen工具：wget https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh && sudo chmod +x install.sh && sudo ./install.sh && rm install.sh。
2. 从Postman导出集合为JSON文件。
3. 使用docgen build -i <JSON文件路径> -o <输出文件路径> -m命令生成Markdown文档，或使用docgen server -f <JSON文件路径> -p <端口号>在线预览HTML文档。

最新问答