匯入 API Blueprint 文件
API Blueprint 以加強版 Markdown 描述 API。Restorm 使用官方剖析器 (Drafter)分析它,該剖析器已編譯為 WebAssembly 並內嵌在程式中:不需要任何外部 工具。
檔案 ▸ 匯入(Ctrl+I),然後選擇 .apib 檔案,或貼上以 FORMAT: 1A
開頭的內容。
| 項目 | Restorm 的處理方式 |
|---|---|
| 資源群組 | 資料夾 |
| 每個轉換(transition) | 一個 HTTP 請求 |
| 參數 | 已標註型別 |
| 伺服器 URL | 環境的基底 URL |
| 描述與模型 | API 文件 |
一個轉換有多個範例
Section titled “一個轉換有多個範例”一個 API Blueprint 轉換可以宣告多組 + Request / + Response 配對。Restorm 會
為每一組配對建立一個請求,並加上索引後綴(#1、#2…)以便區分。