API 文件
一個 Collection 只要維護得夠完整(清楚的請求名稱、描述、範例回應),就等於已經寫好一半的 API 文件。Postman 能直接把 Collection 轉成一份漂亮、可搜尋、可發布給外部使用者的文件網頁,不用再另外用其他工具重寫一次。
讓 Collection 變成好文件
文件品質取決於 Collection 本身寫得多完整:
- 每支請求的 Description 寫清楚用途、必填參數與可能的錯誤情況。
- 幫每支請求加上至少一組 Example(範例回應),文件會直接顯示範例的 Request/Response。
- Collection 本身的說明欄位,適合寫這個 API 的整體介紹、版本資訊、認證方式總覽。
產生與發布文件
- 開啟 Collection,點右上角 ⋯ 選單或側欄的 Docs(View complete documentation)。
- Postman 會依照 Collection 結構,自動產生一份文件頁面,包含每支請求的方法、URL、參數、範例。
- 想公開分享給團隊外的人,可以按 Publish,取得一個公開網址;不想公開,也可以只在 Team Workspace 內部查看。
- 文件會隨著 Collection 更新自動同步,不用像手寫文件那樣,改了 API 卻忘記同步更新說明。
與 OpenAPI 的關係
如果團隊已經維護 OpenAPI(Swagger)規格檔,可以直接匯入 Postman 自動產生對應的 Collection 與請求;反過來,也能把 Postman Collection 匯出成 OpenAPI 格式,交給其他工具(例如產生 SDK、串接 API Gateway)使用。兩種文件系統可以互相搭配,不一定要二選一。
下一步
文件解決「怎麼呼叫」的問題,如果想把多支 API 串成一條自動化流程,可以進一步認識視覺化的 Postman Flows。