數據 API 產生器命令列介面參考
Data API builder 命令行介面 (CLI) (dab CLI 或 dab) 是一種命令行工具，可簡化使用 Data API 產生器之應用程式的本機開發體驗。
提示
數據 API 產生器 CLI 隨附整合式說明系統。 若要取得可用的命令清單，請使用 --help 命令上的 dab 選項。
dab --help
若要取得特定命令的說明，請使用 --help 選項。 例如，若要深入瞭解 init 命令：
dab init --help
命令行動詞和選項
init
初始化數據 API 產生器運行時間引擎的運行時間組態。 它會使用提供做為選項的屬性來建立新的 JSON 檔案。
語法
dab init [options]
範例
dab init --config "dab-config.mssql.json" --database-type mssql --connection-string "@env('SQL_CONNECTION_STRING')"
dab init --database-type mysql --connection-string "@env('MYSQL_CONNECTION_STRING')" --graphql.multiple-create.enabled true
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| --database-type | ✔️ 是 | ✔️ 是 | 字串 | 要連線的資料庫類型。 支援的值：mssql、、、cosmosdb_nosqlcosmosdb_postgresql、mysql。postgresql |
|
| --connection-string | ❌ 否 | "" |
✔️ 是 | 字串 | 線上到資料庫的連線詳細數據。 |
| --cosmosdb_nosql-database | ✔️ 是 ¹ | ✔️ 是 | 字串 | 適用於 NoSql 的 Cosmos DB 資料庫名稱。 | |
| --cosmosdb_nosql-container | ❌ 否 | ✔️ 是 | 字串 | 適用於 NoSql 的 Cosmos DB 容器名稱。 | |
| --graphql-schema | ✔️ 是 ¹ | ✔️ 是 | 字串 | GraphQL 架構路徑 | |
| --set-session-context | ❌ 否 | false |
❌ 否 | 使用會話內容啟用將數據傳送至 MsSql。 | |
| --host-mode | ❌ 否 | production |
✔️ 是 | 字串 | 指定主機模式 - 開發或生產環境 |
| --cors-origin | ❌ 否 | "" |
✔️ 是 | 字串 | 指定允許的來源清單。 |
| --auth.provider | ❌ 否 | StaticWebApps |
✔️ 是 | 字串 | 指定識別提供者。 |
| --rest.path | ❌ 否 | /api |
✔️ 是 | 字串 | 指定 REST 端點的前置詞。 |
| --rest.disabled | ❌ 否 | false |
❌ 否 | 停用所有實體的 REST 端點。 | |
| --rest.enabled | ❌ 否 | true |
✔️ 是 | 為所有實體啟用 REST 端點。 | |
| --rest.request-body-strict | ❌ 否 | true |
✔️ 是 | 不允許要求本文中的無關欄位。 | |
| --graphql.path | ❌ 否 | /graphql |
✔️ 是 | 字串 | 指定 GraphQL 端點的前置詞。 |
| --graphql.disabled | ❌ 否 | false |
❌ 否 | 停用所有實體的 GraphQL 端點。 | |
| --graphql.enabled | ❌ 否 | true |
✔️ 是 | 啟用所有實體的 GraphQL 端點。 | |
| --graphql.multiple-create.enabled | ❌ 否 | false |
✔️ 是 | 在 GraphQL 中啟用多個建立功能。 | |
| --auth.audience | ❌ 否 | ✔️ 是 | 字串 | 識別 Json Web 令牌 (JWT) 的收件者。 | |
| --auth.issuer | ❌ 否 | ✔️ 是 | 字串 | 指定發出 JWT 令牌的合作物件。 | |
| -c,--config | ❌ 否 | dab-config.json |
✔️ 是 | 字串 | 組態檔的路徑。 |
¹ 只有在 設定為 cosmosdb_nosql時--database-type，才需要此選項。
add
將新的資料庫實體新增至組態檔。 在執行此命令之前，請確定您已經有組態檔，否則會傳回錯誤。
語法
dab add [entity-name] [options]
範例
dab add Book -c "dab-config.MsSql.json" --source dbo.books --permissions "anonymous:*"
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| -s,--source | ✔️ 是 | ✔️ 是 | 字串 | 源數據表或容器的名稱。 | |
| --權限 | ✔️ 是 | ✔️ 是 | 字串 | 存取源數據表或容器所需的許可權。 格式： [role]:[actions]。 |
|
| --source.type | ❌ 否 | table |
✔️ 是 | 字串 | 資料庫物件的類型。 支援的值：table、、。viewstored-procedure |
| --source.params | ❌ 否 | ✔️ 是 | 字串 | Source 對象的參數及其值的字典。 param1:val1,param2:value2,... 適用於預存程式。 |
|
| --source.key欄位 | ✔️ 是 ¹ | ✔️ 是 | 字串 | 一或多個字段，僅做為數據表和檢視的主鍵。 逗號分隔值。 範例：--source.key-fields "id,name,type"。 |
|
| --休息 | ❌ 否 | 區分大小寫的實體名稱 | ✔️ 是 | 字串 | REST API 的路由。 範例： --rest: false -> 停用此實體的 REST API 呼叫。 --rest: true -> 實體名稱會變成其餘路徑。 --rest: "customPathName" -> 提供的 customPathName 會變成 REST 路徑。 |
| --rest.methods | ❌ 否 | post |
✔️ 是 | 字串 | 預存程式支援的 HTTP 動作。 將動作指定為逗號分隔清單。 有效的 HTTP 動作為：[get、post、put、patch、delete]。 |
| --graphql | ❌ 否 | 區分大小寫的實體名稱 | ✔️ 是 | Bool/String | 針對 GraphQL 公開的實體類型。 範例： --graphql: false -> 停用此實體的 graphql 呼叫。 --graphql: true -> 公開具有預設名稱之 GraphQL 的實體。 查詢和變動名稱會考慮實體名稱的單一形式。 --graphql: "customQueryName" -> 明確設定單一值，而 DAB 會將查詢和變化所提供的值複數複寫。 --graphql: "singularName:pluralName" -> 設定以冒號分隔的單數和複數值 (用於查詢和變異的冒號 :) 。 |
| --graphql.operation | ❌ 否 | mutation |
✔️ 是 | 字串 | 要支援預存程式的 GraphQL 作業。 支援的值：query、mutation。 |
| --fields.include | ❌ 否 | ✔️ 是 | 字串 | 具有存取權的欄位。 | |
| --fields.exclude | ❌ 否 | ✔️ 是 | 字串 | 從動作清單中排除的欄位。 | |
| --policy-database | ❌ 否 | ✔️ 是 | 字串 | 指定插入至傳送至資料庫的查詢中的 OData 樣式篩選規則。 | |
| -c,--config | ❌ 否 | dab-config.json |
✔️ 是 | 字串 | 組態檔的路徑。 |
¹ 只有在 設定為 view時才--source.type需要此選項。
update
更新組態檔中任何資料庫實體的屬性。
注意
dab update 支援支援的所有選項 dab add。 此外，它也支援列出的選項。
語法
dab update [entity-name] [options]
範例
dab update Publisher --permissions "authenticated:*"
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| --關係 | ❌ 否 | ✔️ 是 | 字串 | 指定兩個實體之間的關聯性。 提供關聯性的名稱。 | |
| --基數 | ✔️ 是 ¹ | ✔️ 是 | 字串 | 指定兩個實體之間的基數。 可以是一或多個。 | |
| --target.entity | ✔️ 是 ¹ | ✔️ 是 | 字串 | 來源實體所關聯的另一個公開實體。 | |
| --linking.object | ❌ 否 | ✔️ 是 | 字串 | 用來支援 M：N 關聯性的資料庫物件。 | |
| --linking.source.fields | ❌ 否 | ✔️ 是 | 字串 | 鏈接物件中的資料庫欄位，以連接到來源實體中的相關專案。 逗號分隔欄位。 | |
| --linking.target.fields | ❌ 否 | ✔️ 是 | 字串 | 鏈接物件中的資料庫欄位，以連接到目標實體中的相關專案。 逗號分隔欄位。 | |
| --relationship.fields | ❌ 否 | ✔️ 是 | 字串 | 指定要用於對應實體的欄位。 範例： --relationship.fields "id:book_id". 在這裡， id 代表sourceEntity的數據行，而 book_id 來自 targetEntity。 如果未指定，基礎來源之間需要外鍵。 |
|
| -m,--map | ❌ 否 | ✔️ 是 | 字串 | 指定資料庫欄位與 GraphQL 和 REST 欄位之間的對應。 格式： --map "backendName1:exposedName1, backendName2:exposedName2,..."。 |
¹ 只有在使用 選項時 --relationship ，才需要此選項。
export
將所需的架構匯出為檔案，並根據選項儲存至磁碟。
語法
dab export [options]
範例
dab export --graphql -o ./schemas
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| --graphql | ❌ 否 | false |
❌ 否 | 匯出 GraphQL 架構。 | |
| -o,--output | ✔️ 是 | ✔️ 是 | 字串 | 指定要儲存架構檔案的目錄。 | |
| -g,--graphql-schema-file | ❌ 否 | schema.graphql |
✔️ 是 | 字串 | 指定 Graphql 架構檔案的名稱。 |
| -c,--config | ❌ 否 | dab-config.json |
✔️ 是 | 字串 | 組態檔的路徑。 |
start
使用提供的組態檔啟動運行時間引擎，以提供 REST 和 GraphQL 要求。
語法
dab start [options]
範例
dab start
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| --詳細 | ❌ 否 | ❌ 否 | 將記錄層級指定為參考。 | ||
| --LogLevel | ❌ 否 | Debug 當 時 hostMode=development，則為 ，否則 Error 為 HostMode=Production |
✔️ 是 | 字串 | 將記錄層級指定為提供的 值。 範例：偵錯、錯誤、資訊等。 |
| --no-https-redirect | ❌ 否 | false |
✔️ 是 | 字串 | 停用自動 HTTPs 重新導向。 |
| -c,--config | ❌ 否 | dab-config.json |
✔️ 是 | 字串 | 組態檔的路徑。 |
注意
--verbose您無法同時使用 與 --LogLevel 。 如需不同記錄層級的詳細資訊，請參閱 .NET 記錄層級。
validate
驗證數據 API 產生器運行時間引擎所使用的運行時間組態檔。 驗證程式可確保組態檔符合架構規範，並包含運行時間引擎正常運作的所有必要資訊。
語法
dab validate [options]
範例
dab validate
選項
| 選項 | 必要選項 | 預設值 | 必要值 | 數值類型 | Description |
|---|---|---|---|---|---|
| -c,--config | ❌ 否 | dab-config.json |
✔️ 是 | 字串 | 驗證目標組態檔的路徑。 |