Informazioni di riferimento sullo schema di configurazione di Generatore API dati

Il generatore di API dati richiede almeno un file di configurazione da eseguire. Questo file basato su JSON definisce la configurazione dell'API, dalle impostazioni dell'ambiente alle definizioni di entità. Inizia con una $schema proprietà che abilita la convalida dello schema per il resto del file.

Proprietà di primo livello

Proprietà dell'origine dati

Proprietà di runtime

Proprietà delle entità

Schema

Ogni file di configurazione inizia con una $schema proprietà , specificando lo schema JSON per la convalida.

Format

{
  "$schema": <string>
}

Example

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

Versioning

I file di schema sono disponibili in URL specifici, assicurandosi di poter usare la versione corretta o lo schema disponibile più recente.

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

Sostituire VERSION-suffix con la versione desiderata.

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

File di origine dati

Il generatore di API dati supporta più file di configurazione, con uno designato come file di primo livello che gestisce runtime le impostazioni. Tutte le configurazioni condividono lo stesso schema JSON, consentendo runtime le impostazioni in qualsiasi file o in ogni file senza errori. Suddividere le entità per un'organizzazione migliore.

Format

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

Più regole di configurazione

• Ogni file di configurazione deve includere la proprietà data-source.
• Ogni file di configurazione deve includere la entities proprietà (o autoentities).
• La configurazione di primo livello deve includere runtime.
• Le configurazioni figlio possono includere runtime, ma il generatore di API dati lo ignora.
• I file di configurazione figlio possono includere i propri file figlio.
• I file di configurazione possono essere organizzati in sottocartelle.
• I nomi delle entità devono essere univoci in tutti i file di configurazione.
• Le relazioni tra entità in file di configurazione diversi non sono supportate.

Examples

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

Autoentities

La autoentities sezione definisce regole basate su criteri che espongono automaticamente oggetti di database corrispondenti come entità DAB all'avvio. Ogni chiave nell'oggetto è una definizione denominata contenente modelli, un modello e autorizzazioni.

Quando autoentities è presente, la entities sezione non è più necessaria. Lo schema di configurazione consente o autoentitiesentities (o entrambi). Se entrambi sono presenti, le entità definite in modo esplicito hanno la precedenza sulle corrispondenze di auto con lo stesso nome.

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

Proprietà

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

Con questa configurazione, ogni tabella e vista nello dbo schema (ad eccezione di quelle corrispondenti dbo.internal%) viene esposta automaticamente come entità DAB. Ogni entità viene denominata usando il {schema}_{object} modello (ad esempio dbo_Products, ), ha REST e GraphQL abilitato, usa la memorizzazione nella cache con una durata (TTL) di 30 secondi e concede read l'accesso anonymous al ruolo.

Azure Key Vault (Archivio chiavi di Azure)

Configura l'integrazione di Azure Key Vault per la gestione dei segreti. Quando presente, la endpoint proprietà è obbligatoria.

Proprietà annidate

Per fare riferimento ai segreti archiviati in Azure Key Vault, usare la @akv() funzione nei valori di configurazione. Il generatore di API dati risolve questi riferimenti all'avvio usando l'endpoint configurato.

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