跳到內容

匯入 API

Restorm 能辨識 二十四種格式,並依據它們重建一棵完整的專案樹:資料夾、請求、 環境、API 文件、列舉。

這幾乎永遠是最好的起點:既然已經有規格文件,就不必再手寫請求。

檔案 ▸ 匯入Ctrl+I)接受:

  • 磁碟上的檔案
  • URL — 對於線上提供的 swagger.json$metadata 特別方便;
  • 貼上的內容 — 把一道 curl 命令變成請求就是這樣做的。

Restorm 會自行判斷格式:先看檔案的副檔名,再分析內容。您無須做任何選擇。

「匯入請求」對話框:可貼上路徑、URL 或 curl 命令的單一欄位,身分驗證路徑、固定標頭與 gRPC 反射的按鈕,拖放區域,以及突顯出來的格式卡片

格式頁面
OpenAPI 3.x 與 Swagger 2.0OpenAPI / Swagger
GraphQL 結構(SDL)GraphQL
.proto 檔案與 gRPC 反射gRPC
WSDLSOAP / WSDL
AsyncAPIAsyncAPI
OData EDMX / CSDLOData
OpenRPCOpenRPC
tRPC 結構tRPC
SmithySmithy
TypeSpecTypeSpec
RAMLRAML
WADLWADL
ThriftThrift
API BlueprintAPI Blueprint
格式頁面
PostmanPostman
InsomniaInsomnia
BrunoBruno
Thunder ClientThunder Client
Paw / RapidAPIPaw
HTTPieHTTPie
VS Code REST Client(.httpREST Client
格式頁面
HAR(瀏覽器擷取)HAR
curl 命令cURL
Invoke-RestMethod / Invoke-WebRequestPowerShell

依來源格式的豐富程度而定:

  • 一個環境資料夾,內含一個或多個環境,基底 URL 取自規格文件;
  • 一棵資料夾樹狀結構 — 依格式而定,可能按標籤、按服務或按資源劃分;
  • 每個操作一個請求,型別對應到相應的協定;
  • 附加在資料夾上的 API 文件:模型、描述、安全性結構、範例回應;
  • 規格文件中的列舉,可作為值型別重複使用;
  • 預先接好線的身分驗證標頭及其變數 — 請參閱 身分驗證

匯入完成後,任何值解析結果為空的鍵/值配對都會自動停用:您第一次傳送時, 不會帶著一大堆空白標頭出門。

匯入不只產生請求:它還保留該 API 的文件 — 描述、模型、安全性、範例、列舉, 都能在所建立資料夾的 Docs 分頁中查閱。請參閱 存取與更新已匯入 API 的文件

有十二種格式支援重新同步:Restorm 會把來源的新版本與現有的樹狀結構相比, 只套用差異,不會遺失您所做的修改。請參閱 從來源更新

Restorm 會為每個請求產生程式碼片段,涵蓋其協定所有相關的語言。請參閱 程式碼匯出