데이터 API 작성기 구성 스키마 참조

데이터 API 작성기를 실행하려면 하나 이상의 구성 파일이 필요합니다. 이 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 작성기에서는 최상위 파일 관리 설정으로 지정된 여러 구성 파일을 지원합니다 runtime . 모든 구성은 동일한 JSON 스키마를 공유하므로 runtime 오류 없이 모든 파일에서 설정을 허용합니다. 더 나은 조직을 위해 엔터티를 분할합니다.

Format

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

여러 구성 규칙

• 모든 구성 파일에는 data-source 속성이 포함되어야 합니다.
• 모든 구성 파일에는 속성(또는autoentities)이 entities 포함되어야 합니다.
• 최상위 구성에는 다음이 포함되어 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 더 이상 필요하지 않습니다. 구성 스키마는 둘 중 하나 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_ProductsREST 및 GraphQL을 사용하도록 설정), 30초 TTL(Time to Live)으로 캐싱을 사용하고, 역할에 대한 액세스 권한을 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')"
  }
}