Linux版Postman如何进行接口文档生成

2025年7月9日 互联网

在Linux系统下使用Postman生成API文档，可以按照以下步骤进行：

使用Postman界面生成API文档

  1. 创建和整理API请求：
  • 打开Postman应用，创建一个新的请求。
  • 输入API的URL、HTTP方法（如GET、POST等）以及必要的请求头和请求体。
  • 发送请求并查看响应。
  • 为每个接口添加详细的描述信息，包括接口的作用、参数、请求头、请求体以及预期响应。最好提供成功、失败和异常情况的示例响应。
  1. 预览和发布API文档：
  • 在集合的选项中，点击“View in Web”，即可在浏览器中预览创建的文档和示例。
  • 点击“Publish Docs”，生成一个公开的网页链接（Public URL），所有人都可以查看。

使用第三方工具导出为HTML或Markdown

Postman本身不直接支持将JSON转换为HTML或Markdown，但你可以使用第三方工具如docgen来实现这一功能。

  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
  1. 转换JSON为HTML和Markdown：
  • 从Postman导出你的API集合为JSON文件（例如，~/Downloads/my_api.json）。
  • 使用docgen转换：
docgen server -f ~/Downloads/my_api.json -p 8000  # 在线预览HTML文档
docgen build -i ~/Downloads/my_api.json -o ~/Downloads/my_api.html  # 生成本地HTML文档
docgen build -i ~/Downloads/my_api.json -o ~/Downloads/my_api.md -m  # 生成本地Markdown文档

使用Postman命令行工具（newman）

Postman的命令行工具newman提供更强大的文档生成和管理能力。

  1. 安装Postman CLI：
sudo apt-get install libgconf-2-4
wget https://dl.pstmn.io/download/latest/linux64 -O postman.tar.gz
sudo tar -xzf postman.tar.gz -C /opt
sudo ln -s /opt/Postman/Postman /usr/bin/postman
  1. 生成和发布文档：
newman run /path/to/my_api.json -e /path/to/my_environment.json -o /path/to/output.html

通过以上方法，你可以在Linux系统下使用Postman生成和管理API文档，从而提高API的可读性和可维护性，促进团队间的协作和沟通。

最新文章