請求工作區與環境
請求工作區是設計好的操作變成真實呼叫的地方。它透過本機主程序發送請求,顯示回應,並用環境和變數管理在不同執行之間變化的值。
發送請求
- 在請求工作區打開一個操作。方法、路徑、參數、請求頭和請求體都取自規範。
- 填入任何需要具體輸入的值,例如路徑參數或權杖。
- 發送請求。該標籤頁會顯示狀態碼、回應頭、回應體和耗時。
- 把多個請求保留在標籤頁中,方便比較或再次查看。
由於執行發生在主程序而非網頁檢視中,瀏覽器的直接 CORS 限制不會阻擋你的呼叫,請求細節也不會透過瀏覽器網路面板暴露。
環境與 OAS servers 的對比
兩者相關但不同,理解它們的區別能消除一個常見困惑來源。
| 自訂環境 | OAS servers | |
|---|---|---|
| 存在位置 | 本機應用程式設定 | OpenAPI 文件內部 |
| 能否由請求工具寫入 | 能 | 不能——用規範補丁修改 |
| 用途 | 新請求標籤頁和場景執行的預設基礎 URL | 合約自身宣告的基礎 URL |
| 是否隨文件共享 | 否 | 是 |
當助手列出基礎 URL(env.listServers)時,它先回傳你可寫的自訂環境,然後是當前文件中宣告的只讀 servers。
- 要新增或選擇本機基礎 URL,建立或啟用一個自訂環境(
env.upsertServer、env.selectServer)。這從 不會編輯文件。 - 要變更合約中的 servers,改為提出一個規範補丁。
這樣把個人除錯用的基礎 URL 與合約分開,同時仍讓文件宣告的 servers 驅動請求。
變數
變數跨四個作用域管理:
- globals(全域)——跨所有集合可用;
- collection(集合)——作用於某個集合;
- environment(環境)——綁定到當前環境;除非指定了某個 server,否則套用於每個 server;
- local(本機)——本機工作階段私有。
助手可以列出變數(env.listVariables,可按作用域過濾)並建立或更新變數(env.setVariable,按名稱和作用域 upsert)。變數可以綁定到特定 server,每個變數都有啟用狀態。設定變數是應用程式動作,不是對 API 文件的變更。
通常存為變數的值包括存取權杖、跨呼叫重用的 ID 和功能開關。
當基礎 URL 缺失時
請求需要完整 URL。如果文件的 servers 和當前環境都沒有提供基礎 URL,應用程式不會猜測——它會在執行前請你提供一個。這比悄悄呼叫錯誤的主機更可取。