阅读量:2
在Linux上使用Postman生成API文档，可参考以下方法：
使用Postman界面生成
- 创建并组织API请求集合：打开Postman，创建新集合，添加API请求，为每个请求添加详细描述，包括请求方法、URL、参数等，还可添加成功、失败等示例响应。
- 预览和发布文档：在集合选项中，点击“View in Web”可预览文档，点击“Publish Docs”可生成公开URL分享文档。
使用第三方工具导出
- 安装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安装。 - 导出文档：从Postman导出集合为JSON文件，再用
docgen转换，如docgen build -i ~/Downloads/my_api.json -o ~/Downloads/my_api.html生成HTML文档。
使用Postman命令行工具
- 安装Postman CLI：参考文档安装，如使用Snap安装
sudo snap install postman。 - 生成文档：使用
newman run /path/to/postman_collection.json -e /path/to/postman_environment.json -o /path/to/output.html命令生成HTML文档。
以上就是关于“如何在Linux上使用Postman进行API文档生成”的相关介绍，筋斗云是国内较早的云主机应用的服务商，拥有10余年行业经验，提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩，主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复；电子化备案，提交快速，专业团队7×24小时服务支持！
简单好用、高性价比云服务器租用链接：https://www.jindouyun.cn/product/cvm