データ API ビルダー構成スキーマ リファレンス

データ API ビルダーを実行するには、少なくとも 1 つの構成ファイルが必要です。 この JSON ベースのファイルは、環境設定からエンティティ定義まで、API のセットアップを定義します。 ファイルの残りの部分のスキーマ検証を有効にする $schema プロパティで始まります。

最上位のプロパティ

データ ソースのプロパティ

ランタイム のプロパティ

エンティティのプロパティ

Schema

各構成ファイルは、検証用の JSON スキーマを指定する$schema プロパティで始まります。

Format

{
  "$schema": <string>
}

Example

{
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json"
}

Versioning

スキーマ ファイルは特定の URL で使用できるため、適切なバージョンまたは使用可能な最新のスキーマを使用できます。

https://github.com/Azure/data-api-builder/releases/download/<VERSION>-<suffix>/dab.draft.schema.json

VERSION-suffix を目的のバージョンに置き換えます。

https://github.com/Azure/data-api-builder/releases/download/v0.3.7-alpha/dab.draft.schema.json

データ ソース ファイル

データ API ビルダーは、複数の構成ファイルをサポートします。1 つは、 runtime 設定を管理する最上位ファイルとして指定されています。 すべての構成で同じ JSON スキーマが共有されるため、エラーなしで任意のファイルまたはすべてのファイルで runtime 設定が可能になります。 組織を改善するためにエンティティを分割します。

Format

{
  "data-source-files": [ "<string>" ]
}

複数の構成規則

• すべての構成ファイルに、data-source プロパティを含める必要があります。
• すべての構成ファイルには、 entities プロパティ (または autoentities) が含まれている必要があります。
• 最上位の構成には、 runtimeを含める必要があります。
• 子構成には runtimeを含めることができますが、Data API ビルダーでは無視されます。
• 子構成ファイルには、独自の子ファイルを含めることができます。
• 構成ファイルはサブフォルダーに編成できます。
• エンティティ名は、すべての構成ファイルで一意である必要があります。
• 異なる構成ファイル内のエンティティ間のリレーションシップはサポートされていません。

Examples

{
  "data-source-files": [
    "dab-config-2.json",
    "my-folder/dab-config-3.json",
    "my-folder/my-other-folder/dab-config-4.json"
  ]
}

Autoentities

autoentitiesセクションでは、起動時に一致するデータベース オブジェクトを DAB エンティティとして自動的に公開するパターンベースのルールを定義します。 オブジェクト内の各キーは、パターン、テンプレート、およびアクセス許可を含む名前付き定義です。

autoentitiesが存在する場合、entitiesセクションは不要になります。 構成スキーマでは、 autoentities または entities (またはその両方) を使用できます。 両方が存在する場合、明示的に定義されたエンティティは、同じ名前の自動エンティティの一致よりも優先されます。

Format

{
  "autoentities": {
    "<definition-name>": {
      "patterns": {
        "include": [ "<string>" ],
        "exclude": [ "<string>" ],
        "name": "<string>"
      },
      "template": {
        "mcp": { "dml-tools": <boolean> },
        "rest": { "enabled": <boolean> },
        "graphql": { "enabled": <boolean> },
        "health": { "enabled": <boolean> },
        "cache": {
          "enabled": <boolean>,
          "ttl-seconds": <integer>,
          "level": "<string>"
        }
      },
      "permissions": [
        {
          "role": "<string>",
          "actions": [ { "action": "<string>" } ]
        }
      ]
    }
  }
}

プロパティ

Example

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "exclude": [ "dbo.internal%" ],
        "name": "{schema}_{object}"
      },
      "template": {
        "rest": { "enabled": true },
        "graphql": { "enabled": true },
        "cache": { "enabled": true, "ttl-seconds": 30, "level": "l1l2" }
      },
      "permissions": [
        { "role": "anonymous", "actions": [ { "action": "read" } ] }
      ]
    }
  }
}

この構成では、 dbo スキーマ内のすべてのテーブルとビュー (一致する dbo.internal%を除く) が DAB エンティティとして自動的に公開されます。 各エンティティは、{schema}_{object} パターン (dbo_Products など) を使用して名前が付けられ、REST と GraphQL が有効になり、30 秒の有効期間 (TTL) でキャッシュが使用され、anonymous ロールへのアクセスread許可されます。

Azure Key Vault

シークレットを管理するための Azure Key Vault 統合を構成します。 存在する場合は、 endpoint プロパティが必要です。

入れ子になったプロパティ

Azure Key Vault に格納されているシークレットを参照するには、構成値で @akv() 関数を使用します。 データ API ビルダーは、構成されたエンドポイントを使用して、起動時にこれらの参照を解決します。

Format

{
  "azure-key-vault": {
    "endpoint": "<string>",
    "retry-policy": {
      "mode": <"exponential"> (default) | <"fixed">,
      "max-count": <integer; default: 3>,
      "delay-seconds": <integer; default: 1>,
      "max-delay-seconds": <integer; default: 60>,
      "network-timeout-seconds": <integer; default: 60>
    }
  }
}

Example

{
  "azure-key-vault": {
    "endpoint": "https://my-vault.vault.azure.net/",
    "retry-policy": {
      "mode": "exponential",
      "max-count": 5,
      "delay-seconds": 2,
      "max-delay-seconds": 120,
      "network-timeout-seconds": 90
    }
  },
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@akv('sql-connection-string')"
  }
}