Linux Postman如何生成文檔

在Linux系統下使用Postman生成API文檔，可以按照以下步驟進行：

1. 創建和整理API請求

• 創建接口集合：在Postman中創建一個接口集合，描述該接口集合的功能和范圍等信息。
• 添加接口：將所有需求已清晰的接口定義到集合當中。
• 描述接口：為每個接口添加描述信息，包括接口的作用、參數、請求頭和請求體等。
• 生成樣例：為接口生成成功樣例、失敗樣例和異常樣例，以便展示接口的不同執行結果。

2. 預覽和發布API文檔

• 預覽文檔：在集合的選項中，點擊“View in Web”，即可在瀏覽器中預覽創建的文檔和示例。
• 發布文檔：如果想讓其他人能看到這個文檔，可以點擊“Publish Docs”，生成一個公開的網頁鏈接（Public URL），所有人都可以查看。

3. 使用第三方工具導出為HTML或Markdown

Postman本身不直接支持將JSON轉換為HTML或Markdown，但你可以使用第三方工具如docgen來實現這一功能。

安裝docgen

# 安裝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

轉換JSON為HTML和Markdown

# 從Postman導出為JSON文件
docgen server -f ~/Downloads/Api_Test_postman_collection.json -p 8000

# 查看實時在線HTML文檔
docgen server -f ~/Downloads/Api_Test_postman_collection.json -p 8000

# 生成本地HTML文檔
docgen build -i ~/Downloads/Api_Test_postman_collection.json -o ~/Downloads/Api_Test_postman_collection.html

# 生成本地Markdown文檔
docgen build -i ~/Downloads/Api_Test_postman_collection.json -o ~/Downloads/Api_Test_postman_collection.md -m

4. 使用Postman命令行工具

如果你更喜歡使用命令行，可以安裝Postman命令行工具，然后使用newman來生成和發布文檔。

安裝Postman命令行工具

# 安裝必要的依賴
sudo apt-get install libgconf-2-4

# 下載Postman CLI工具
wget https://dl.pstmn.io/download/latest/linux64 -O postman.tar.gz

# 解壓到/opt目錄
sudo tar -xzf postman.tar.gz -C /opt

# 創建軟鏈接
sudo ln -s /opt/Postman/Postman /usr/bin/postman

生成和發布文檔

# 使用newman生成HTML文檔
newman run /path/to/postman_collection.json -e /path/to/postman_environment.json -o /path/to/output.html

通過以上步驟，你可以在Linux系統下使用Postman生成和管理API文檔，從而提高API的可讀性和可維護性，促進團隊間的協作和溝通。