跳到內容

匯入 OpenAPI / Swagger

這是 Restorm 最完整的匯入方式。可辨識三個版本:Swagger 2.0OpenAPI 3.0OpenAPI 3.1

檔案 ▸ 匯入Ctrl+I),然後選擇 swagger.json / openapi.json 檔案,或 直接填入規格文件的 URL

如果該 URL 回應 401403,Restorm 會提議附加身分驗證後重試,過程中不必離開 匯入對話框。

側邊面板中由 OpenAPI 匯入產生的樹狀結構 — 每個標籤一個資料夾(pet、store、user) — 旁邊是環境資料夾的首頁子分頁

規格文件項目Restorm 的處理方式
servers(或 host + basePath + schemes環境的基底 URL,伺服器變數已解析
tags每個標籤一個資料夾,其餘則歸入一個 Other 資料夾
每個操作一個 HTTP 請求,含方法與路徑
參數路徑參數、查詢參數與標頭,皆已標註型別(字串、數字、日期時間、列舉、密鑰…)
requestBody內文,並套用其內容類型
examples以所提供的範例預先填好的內文
components / definitionsAPI 文件:模型、描述
enum可作為值型別重複使用的列舉
回應依內容類型分別記錄成文件

$ref 都會被解析,跨元件的引用也一樣。

components / definitions 這一列值得特別強調:匯入不只涵蓋請求,它還保留了 整份 API 文件 — 描述、模型、安全性結構、範例、列舉。這些內容既可在匯入所產生 環境資料夾的 Docs 分頁中查閱,也可在每個請求自己的 Docs 分頁中查閱,並且能從 來源重新同步。請參閱 存取與更新已匯入 API 的文件

匯入所產生環境資料夾的 Docs 分頁,含該 API 的文件與其目錄

所宣告的安全性結構會被轉譯為預先接好線的標頭或參數,並為您建立對應的環境 變數:

結構Restorm 佈置的內容
放在標頭或查詢中的 apiKey一組以該結構命名的配對,值為 {{<schema>}}
http + basicAuthorization: Basic {{<schema>_credentials}}
http + beareroauth2openIdConnectAuthorization: Bearer {{<schema>_token}}

接下來只剩填入變數 — 或者把它換成一條 身分驗證路徑,以享有自動換發的好處。

OpenAPI 與 Swagger 都屬於可重新同步的格式:資料夾的重新整理按鈕會取得來源, Restorm 再套用差異 — 新操作會被加入,消失的操作會被標為已淘汰而非刪除,您的 修改也會保留。請參閱 從來源更新