跳到內容

偵測匯入 API 中的問題

當您匯入 API(OpenAPI、Swagger 以及其他支援的格式)時,Restorm 會將該 API 的結構化文件保存在其環境資料夾中。匯入之後——以及每次重新開啟該檔案時——Restorm 都會悄悄地將該文件投射為一份設計,並完全在背景執行與 API 設計器所套用的相同的驗證。它絕不會阻擋匯入,也絕不會干擾您正在進行的操作。

如果它沒有發現任何問題,您將看不到任何內容。如果它發現了結構性問題,它會在兩個地方向您指出。

承載被標記 API 的環境資料夾會在其列的右側顯示一個小小的**「!」**。這是一目了然的訊號,表示該 API 的設計有值得一看之處——一旦該 API 重新恢復正常(在重新匯入或修復該問題的 API 更新之後),它便會自行消失。

開啟環境資料夾,它會多出一個問題分頁。該分頁僅在偵測到問題時才會出現——正常的 API 從不顯示它。

匯入 API 的環境資料夾的「問題」分頁:一個警告提示框,然後是按類型分組的問題——「多個路由回應相同的方法和路徑」、「某些路由未宣告任何回應」、「某些路由位於設計伺服器保留的路徑上」——每一項都列出它所影響的確切路由,其中一項已展開以顯示該路由的文件

問題按類型分組,因此二十個重複路由會顯示為帶有計數的一列,而不是二十個獨立的項目。在每種類型下,Restorm 會列出所涉及的確切實體——一個路由會顯示其 HTTP 動詞和真實路徑,並展開為該路由的文件,讓您無需離開分頁即可查看它所宣告的內容。

這些檢查與 API 設計器的檢查如出一轍,因此您可能看到的問題類型包括:

  • 重複路由——兩個回應相同方法和路徑的路由;
  • 缺少回應——一個完全未宣告任何回應的路由;
  • 保留路徑——一個位於 Mock Server 所保留路徑上的路由(/swagger.json、/graphql 等),它永遠不會回應;
  • 約束問題——無效的模式,或最小值大於其最大值。

該清單為唯讀:它告訴您需要修復什麼,而您在源頭進行修復(重新匯入更正後的規格,或編輯該 API)。它會在變更 API 的事件上重新計算——開啟檔案、匯入、更新 API——而不是在每次按鍵時。