数据 API 生成器配置架构参考

数据 API 生成器至少需要一个配置文件才能运行。 此基于 JSON 的文件定义 API 设置，从环境设置到实体定义。 它以属性 $schema 开头，该属性为文件的其余部分启用架构验证。

顶级属性

数据源属性

运行时属性

实体属性

Schema

每个配置文件都以属性 $schema 开头，并指定用于验证的 JSON 架构 。

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 生成器支持多个配置文件，其中一个配置文件指定为顶级文件管理 runtime 设置。 所有配置共享相同的 JSON 架构，允许 runtime 任何文件或每个文件中的设置都不会出现错误。 拆分实体以更好地组织。

Format

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

多个配置规则

• 每个配置文件都必须包括 data-source 属性。
• 每个配置文件都必须包含 entities 属性（或 autoentities）。
• 顶级配置必须包括 runtime。
• 子配置可以包含 runtime，但数据 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 部分定义基于模式的规则，这些规则在启动时自动将匹配的数据库对象公开为 DAB 实体。 对象中的每个键都是包含模式、模板和权限的命名定义。

如果 autoentities 存在，则不再需要该 entities 节。 配置架构允许或 autoentitiesentities （或两者）使用。 如果两者都存在，则显式定义的实体优先于具有相同名称的自动匹配项。

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）的缓存，并授予 read 对角色的访问权限 anonymous 。

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')"
  }
}