跳到內容

API 設計器

API 設計器 讓您直接在 Restorm 中設計一個完整的 API:您描述資料和路由, 其餘的交給 Restorm —— 它把您的設計像一個真正的 mock 伺服器一樣 提供服務, 並根據範本 生成 您的應用程式程式碼。

在後端尚不存在時啟動一個 API,這是理想的工具:把契約做成原型,讓您的用戶端 測試它,並把一切以受版本控制的方式保存在您的專案中。

API 設計器概覽:側邊欄列出模型、列舉、路由、伺服器、用戶端和程式碼

設計像任何其他元素一樣建立:右鍵點擊資料夾 ▸ 新增 ▸ API 設計。它在自己的 分頁中開啟,並彙集了可從側邊欄存取的多個區段:

區段用途
模型您的實體及其屬性 —— 參見模型、列舉和屬性。
列舉封閉的值集合,可作為屬性類型重用。
路由API 的進入點,按資源分組 —— 參見路由與 CRUD。
伺服器以 HTTP、GraphQL、SOAP、OData 或 gRPC 將設計作為 mock 提供服務 —— 參見將設計作為 mock 提供服務。
用戶端呼叫執行中 mock 的即用型請求 —— 參見用戶端。
文件 與 備註附加到設計上的自由文件與備註。
程式碼根據您的範本生成程式碼 —— 參見程式碼生成。

設計的 設定(名稱、預設值)透過直接點擊側邊欄中的設計節點開啟。

  1. 描述您的資料 —— 建立模型和列舉,新增它們的屬性、類型和約束。
  2. 定義您的路由 —— 手動定義,或者從模型一鍵 生成 CRUD。
  3. 提供 mock 服務 —— 啟動伺服器並把您的應用程式或用戶端指向它。同一個設計 會自動投影到每個已啟用的協定中。
  4. 生成程式碼 —— 選擇一個或多個範本(您自己的,或 Restorm 提供的)並生成 相應的專案。

每個步驟都在本區段的各頁面中詳細說明。