快速入門
你的第一個端點。
依照 規格,看看一個 vibe-backend 專案長甚麼樣子。
1建立專案結構
project/
├── providers/
│ └── main.md # 資料庫 provider(預設為 PostgreSQL)
├── pipelines/
│ └── login-guard.md # 可重用的請求 pipeline
├── migrations/main/
│ └── 0001-create-users.md # 資料庫 migration(4 位數序號)
├── models/user/
│ ├── user.md # model 定義
│ └── methods/sign-token.md # model method
└── api/users/
├── _definition.md # 「users」API 的共用設定
└── v1/
├── _version.md # v1 版本的設定
└── login/login.md # 入口:POST /users/v1/loginproject/providers/main.md– 資料庫 provider(預設為 PostgreSQL)
pipelines/login-guard.md– 可重用的請求 pipeline
migrations/main/0001-create-users.md– 資料庫 migration(4 位數序號)
models/user/user.md– model 定義methods/sign-token.md– model method
api/users/_definition.md– 「users」API 的共用設定v1/_version.md– v1 版本的設定login/login.md– 入口:POST /users/v1/login
編譯後的 .lock.md 會出現在每個 source 檔旁邊,此處從略。
所有名稱一律使用 kebab-case(a-z0-9-)。以 _ 開頭的檔案為保留檔,永遠不會被路由。
2用自然語言描述功能
feature 檔說明這個端點要做甚麼。可以加上用途、輸入、輸出、做法、錯誤、權限等小標題,幫助編譯器理解(非必要)。
# 登入
公開端點,使用 POST。
## 輸入
- email
- password
## 做法
先執行 login-guard pipeline,再呼叫 user.sign-token 並回傳 token。
## 錯誤
- email 或密碼錯誤時回傳 401。
3編譯、審核、部署
- 編譯器會在 source 旁產生
login.lock.md,內含## Route、## Access、## Request、## Steps、## Errors等固定區段。lock 檔絕對不要手動修改。 - 由 owner 或 maintainer 在 PR review 中確認 lock;驗證器會逐項標示所有安全項目。
- 部署時,已確認的 lock 會合併成簽名 manifest,端點隨即以 serverless 方式上線。
下一步:閱讀文件,了解完整的 lock 格式、驗證規則與範例。