跳到內容

從來源更新

API 規格文件是活的。整批覆寫地重新匯入會讓您的調整全部消失;另開一份重新匯入又 會產生重複。Restorm 採取第三種做法:計算差異

每次匯入成功時,都會在所建立的環境資料夾上記錄一份來源的指紋。資料夾的 重新整理按鈕會取得來源、比對指紋,然後只套用差異,而不是從零開始重做:

  • 新的操作會被加入,位置就是全新匯入原本會放置的地方;
  • 有所變更的操作,其參數會依規格文件新增的內容補齊;
  • 被規格文件標為已淘汰的操作會被標示,並在樹狀清單中呈現淡化樣式;
  • 已從來源消失的操作會被標示為已移除,並呈現刪除線 — 它們仍然可以執行, 而且永遠不會被刪除;
  • 您的修改都會保留:名稱、方法、URL 以及您輸入的值都不會被覆寫。

原則是:規格文件對它所描述的內容有最終決定權,其餘一切由您決定。

完整流程 — 按鈕在哪裡、精靈在套用之前會顯示什麼、文件會有什麼變化 — 說明於 存取與更新已匯入 API 的文件

重新整理之後的樹狀結構:最後一個操作在規格文件的新版本中已不存在,因此呈現淡化並加上刪除線 — 它仍保留在專案中,永遠不會被刪除

共有十二種格式:

HARcURLPowerShellREST ClientThunder ClientPawHTTPieRAMLWADLThriftTypeSpecAPI BlueprinttRPC

對這些格式而言,重新匯入會建立一棵新的樹:您得自行把兩棵樹對照整併,或是匯入到 一個專用的資料夾裡。

以反射匯入的 gRPC 請求,會在自己的分頁上直接帶有一個從反射重新整理按鈕:當某 個服務在開發過程中不斷演進時,這是最短的路徑。