參考手冊
查閱預設範本的設定、環境變數、資源繫結、資料庫、API、型別、Reaction 和專案指令。
本章彙整 saavo-default-template 的設定和開發介面。修改設定、呼叫 API 或排查問題時,可以依檔名、路徑或 Key 直接查找。
內容範圍
本章只介紹 saavo-default-template。設定項目、路由、型別、Event、Command、資料表和專案指令,都以該專案的原始碼為準。
初始化後的專案
本章的預設值取自範本原始檔案。透過 Saavo CLI 建立專案時,CLI 會將 package.json 的名稱改為專案名稱、版本設為 0.0.1,並依專案名稱改寫 Worker、D1、R2 和 Queue 的資源名稱,以及對應的一般變數。程式碼中的 Binding 名稱保持不變,例如 DB、MAIN_R2。
選擇執行本機初始化後,會安裝相依套件、建立 .env 並補上 SAAS_SECRET,接著產生 Binding 型別、初始化本機資料庫並執行檢查。初始化不會建立遠端資源,也不會自動替換品牌、產品、管理員電子郵件地址或第三方服務的驗證資訊。正式使用前,仍須修改這些範例設定。
原始碼套件會移除範本維護者使用的 commit npm script,因此初始化專案的指令集合與範本儲存庫略有不同。
設定與執行環境
這個部分介紹設定檔、環境變數和 Cloudflare 資源繫結。
設定檔
逐項查閱 config 目錄中的設定物件和屬性。
環境變數
查閱 example.vars 宣告的建置變數和執行階段變數。
Cloudflare 資源繫結
查閱 wrangler.jsonc 宣告的 D1、KV、R2、Queue 和 Durable Object。
資料與開發介面
查閱資料表、API、共用型別和 Reaction 定義。
資料庫
查閱兩個 D1 資料庫的資料表、初始化指令碼和資料庫遷移規則。
API
查閱預設範本已註冊的 API 路徑、請求方法和存取要求。
型別定義
查閱請求執行脈絡、Worker 執行脈絡、通用結果和型別所在位置。
領域事件與命令
查閱 Reaction 已註冊的 Event、Command 及其處理方式。