Referens för konfigurationsschema för Data API Builder

Data API Builder kräver minst en konfigurationsfil för att köras. Den här JSON-baserade filen definierar din API-konfiguration, från miljöinställningar till entitetsdefinitioner. Den börjar med en $schema egenskap som aktiverar schemaverifiering för resten av filen.

Egenskaper på den översta nivån

Egenskaper för datakälla

Körningsegenskaper

Egenskaper för entiteter

Schema

Varje konfigurationsfil börjar med en $schema egenskap som anger JSON-schemat för validering.

Format

{
  "$schema": <string>
}

Example

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

Versioning

Schemafiler är tillgängliga på specifika URL:er, vilket säkerställer att du kan använda rätt version eller det senaste tillgängliga schemat.

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

Ersätt VERSION-suffix med den version du vill ha.

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

Datakällans filer

Data API Builder har stöd för flera konfigurationsfiler, där en har angetts som inställningarna för filhantering runtime på den översta nivån. Alla konfigurationer delar samma JSON-schema, vilket tillåter runtime inställningar i alla filer eller filer utan fel. Dela entiteter för bättre organisation.

Format

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

Flera konfigurationsregler

• Varje konfigurationsfil måste innehålla egenskapen data-source.
• Varje konfigurationsfil måste innehålla entities egenskapen (eller autoentities).
• Konfigurationen på den översta nivån måste innehålla runtime.
• Underordnade konfigurationer kan innehålla runtime, men Data API Builder ignorerar det.
• Underordnade konfigurationsfiler kan innehålla egna underordnade filer.
• Konfigurationsfiler kan ordnas i undermappar.
• Entitetsnamn måste vara unika för alla konfigurationsfiler.
• Relationer mellan entiteter i olika konfigurationsfiler stöds inte.

Examples

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

Autoentiteter

Avsnittet autoentities definierar mönsterbaserade regler som automatiskt exponerar matchande databasobjekt som DAB-entiteter vid start. Varje nyckel i objektet är en namngiven definition som innehåller mönster, en mall och behörigheter.

När autoentities är närvarande krävs inte längre avsnittet entities . Konfigurationsschemat tillåter antingen autoentities eller entities (eller båda). Om båda finns har explicit definierade entiteter företräde framför automatiska entiteter som matchar med samma namn.

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>" } ]
        }
      ]
    }
  }
}

Egenskaper

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" } ] }
      ]
    }
  }
}

Med den här konfigurationen exponeras varje tabell och vy i dbo schemat (förutom de matchande dbo.internal%) automatiskt som en DAB-entitet. Varje entitet namnges med hjälp av {schema}_{object} mönstret (till exempel dbo_Products), har REST och GraphQL aktiverat, använder cachelagring med en 30-sekunders TTL (time-to-live) och ger read åtkomst till anonymous rollen.

Azure 密钥保管库

Konfigurerar Azure Key Vault-integrering för hantering av hemligheter. I förekommande fall krävs egenskapen endpoint .

Kapslade egenskaper

Om du vill referera till hemligheter som lagras i Azure Key Vault använder du @akv() funktionen i dina konfigurationsvärden. Data API Builder löser dessa referenser vid start med hjälp av den konfigurerade slutpunkten.

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