init opdracht

Initialiseer een nieuw configuratiebestand voor data-API builder. De resulterende JSON legt gegevensbrondetails vast, ingeschakelde eindpunten (REST, GraphQL, MCP), verificatie en runtimegedrag.

Syntaxis

dab init [options]

Als het doelconfiguratiebestand al bestaat, overschrijft de opdracht het. Er is geen samenvoeging. Gebruik versiebeheer of back-ups als u het vorige bestand wilt behouden.

Snelle blik

Sectie Verificatie

Sectie Gegevensbron

GraphQL-sectie

Sectie Host en verificatie

MCP-sectie

REST-sectie

-c, --config

Naam van uitvoerconfiguratiebestand. De standaardinstelling is dab-config.json.

Example

dab init \
  --database-type mssql \
  --config dab-config.local.json

dab init ^
  --database-type mssql ^
  --config dab-config.local.json

Resulterende configuratie

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": ""
  }
}

--auth.audience

JSON Web Token (JWT)-doelgroepclaim.

Example

dab init \
  --database-type mssql \
  --auth.audience "https://example.com/api"

dab init ^
  --database-type mssql ^
  --auth.audience "https://example.com/api"

Resulterende configuratie

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "audience": "https://example.com/api"
        }
      }
    }
  }
}

--auth.issuer

JSON Web Token (JWT)-verlenerclaim.

Example

dab init \
  --database-type mssql \
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

dab init ^
  --database-type mssql ^
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

Resulterende configuratie

{
  "runtime": {
    "host": {
      "authentication": {
        "jwt": {
          "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0"
        }
      }
    }
  }
}

--auth.provider

Id-provider. De standaardinstelling is Unauthenticated.

Als Unauthenticated dab actief is, inspecteert of valideert DAB geen JWT. Alle aanvragen worden uitgevoerd als anonymous. Een andere service kan aanvragen verifiëren of filteren voordat ze DAB bereiken, maar DAB autoriseert nog steeds alleen als anonymous. Als u een andere provider wilt gebruiken, stelt u deze expliciet in.

Zie De niet-geverifieerde provider configureren voor configuratierichtlijnen.

Geldige waarden: Unauthenticated, StaticWebApps, EntraID, AzureAD, , AppService, Simulator. Custom

Example

dab init \
  --database-type mssql \
  --auth.provider AzureAD \
  --auth.audience "https://example.com/api" \
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

dab init ^
  --database-type mssql ^
  --auth.provider AzureAD ^
  --auth.audience "https://example.com/api" ^
  --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

Resulterende configuratie

{
  "runtime": {
    "host": {
      "authentication": {
        "provider": "AzureAD",
        "jwt": {
          "audience": "https://example.com/api",
          "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0"
        }
      }
    }
  }
}

--connection-string

Databaseverbindingsreeks. Ondersteunt @env().

Example

dab init \
  --database-type mssql \
  --connection-string "@env('MSSQL_CONNECTION_STRING')"

dab init ^
  --database-type mssql ^
  --connection-string "@env('MSSQL_CONNECTION_STRING')"

Resulterende configuratie

{
  "data-source": {
    "connection-string": "@env('MSSQL_CONNECTION_STRING')"
  }
}

--cors-origin

Door komma's gescheiden lijst met toegestane oorsprongen.

Example

dab init \
  --database-type mssql \
  --cors-origin "https://app.example.com,https://admin.example.com"

dab init ^
  --database-type mssql ^
  --cors-origin "https://app.example.com,https://admin.example.com"

Resulterende configuratie

{
  "runtime": {
    "host": {
      "cors": {
        "origins": [ "https://app.example.com", "https://admin.example.com" ]
      }
    }
  }
}

--cosmosdb_nosql-container

Naam van Cosmos DB NoSQL-container.

Example

dab init \
  --database-type cosmosdb_nosql \
  --cosmosdb_nosql-container MyContainer

dab init ^
  --database-type cosmosdb_nosql ^
  --cosmosdb_nosql-container MyContainer

Resulterende configuratie

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "container": "MyContainer"
    }
  }
}

--cosmosdb_nosql-database

Naam van Cosmos DB NoSQL-database. Vereist voor cosmosdb_nosql.

Example

dab init \
  --database-type cosmosdb_nosql \
  --cosmosdb_nosql-database MyDb

dab init ^
  --database-type cosmosdb_nosql ^
  --cosmosdb_nosql-database MyDb

Resulterende configuratie

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "database": "MyDb"
    }
  }
}

--database-type

Hiermee geeft u de doeldatabase-engine. Ondersteunde waarden: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init \
  --database-type mssql

dab init ^
  --database-type mssql

Resulterende configuratie

{
  "data-source": {
    "database-type": "mssql"
  }
}

--graphql.disabled

Afgeschreven Hiermee schakelt u GraphQL uit. Liever --graphql.enabled false.

--graphql.enabled

Het GraphQL-eindpunt inschakelen. De standaardinstelling is true.

Example

dab init \
  --database-type mssql \
  --graphql.enabled false

dab init ^
  --database-type mssql ^
  --graphql.enabled false

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "enabled": false
    }
  }
}

--graphql.multiple-create.enabled

Maakt het mogelijk om meerdere rijen in één mutatie te maken. De standaardinstelling is false.

Example

dab init \
  --database-type mssql \
  --graphql.multiple-create.enabled true

dab init ^
  --database-type mssql ^
  --graphql.multiple-create.enabled true

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "multiple-mutations": {
        "create": { "enabled": true }
      }
    }
  }
}

--graphql.path

GraphQL-eindpuntvoorvoegsel. De standaardinstelling is /graphql.

Example

dab init \
  --database-type mssql \
  --graphql.path /gql

dab init ^
  --database-type mssql ^
  --graphql.path /gql

Resulterende configuratie

{
  "runtime": {
    "graphql": {
      "path": "/gql"
    }
  }
}

--graphql-schema

Pad naar een GraphQL-schemabestand. Vereist voor cosmosdb_nosql.

Example

dab init \
  --database-type cosmosdb_nosql \
  --graphql-schema ./schema.gql

dab init ^
  --database-type cosmosdb_nosql ^
  --graphql-schema ./schema.gql

Resulterende configuratie

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "schema": "./schema.gql"
    }
  }
}

--host-mode

Hostmodus. De standaardinstelling is Production.

Geldige waarden: Development, Production.

Example

dab init \
  --database-type mssql \
  --host-mode development

dab init ^
  --database-type mssql ^
  --host-mode development

Resulterende configuratie

{
  "runtime": {
    "host": {
      "mode": "development"
    }
  }
}

--mcp.aggregate-records.query-timeout

Time-out voor uitvoering in seconden voor het MCP-hulpprogramma voor statistische records. De standaardinstelling is 30. Bereik: 1–600.

Example

dab init \
  --database-type mssql \
  --mcp.aggregate-records.query-timeout 60

dab init ^
  --database-type mssql ^
  --mcp.aggregate-records.query-timeout 60

Resulterende configuratie

{
  "runtime": {
    "mcp": {
      "dml-tools": {
        "aggregate-records": {
          "query-timeout": 60
        }
      }
    }
  }
}

--mcp.disabled

Afgeschreven Schakelt MCP uit. Liever --mcp.enabled false.

--mcp.enabled

Schakel HET MCP-eindpunt in. De standaardinstelling is true.

Example

dab init \
  --database-type mssql \
  --mcp.enabled false

dab init ^
  --database-type mssql ^
  --mcp.enabled false

Resulterende configuratie

{
  "runtime": {
    "mcp": {
      "enabled": false
    }
  }
}

--mcp.path

MCP-eindpuntvoorvoegsel. De standaardinstelling is /mcp.

Example

dab init \
  --database-type mssql \
  --mcp.path /model

dab init ^
  --database-type mssql ^
  --mcp.path /model

Resulterende configuratie

{
  "runtime": {
    "mcp": {
      "path": "/model"
    }
  }
}

--rest.disabled

Afgeschreven Schakelt REST uit. Liever --rest.enabled false.

--rest.enabled

Schakel REST-eindpunt in. De standaardinstelling is true.

Example

dab init \
  --database-type mssql \
  --rest.enabled false

dab init ^
  --database-type mssql ^
  --rest.enabled false

Resulterende configuratie

{
  "runtime": {
    "rest": {
      "enabled": false
    }
  }
}

--rest.path

REST-eindpuntvoorvoegsel. De standaardinstelling is /api.

Example

dab init \
  --database-type mssql \
  --rest.path /rest

dab init ^
  --database-type mssql ^
  --rest.path /rest

Resulterende configuratie

{
  "runtime": {
    "rest": {
      "path": "/rest"
    }
  }
}

--rest.request-body-strict

Hiermee bepaalt u de verwerking van extra velden in aanvraagteksten. De standaardinstelling is false.

• true: Weigert overbodige velden (HTTP 400).
• false: Hiermee worden extra velden genegeerd.

Example

dab init \
  --database-type mssql \
  --rest.request-body-strict false

dab init ^
  --database-type mssql ^
  --rest.request-body-strict false

Resulterende configuratie

{
  "runtime": {
    "rest": {
      "request-body-strict": false
    }
  }
}

--runtime.base-route

Globaal voorvoegsel dat is voorafgegaan aan alle eindpunten. Moet beginnen met /.

Example

dab init \
  --database-type mssql \
  --auth.provider StaticWebApps \
  --runtime.base-route /v1

dab init ^
  --database-type mssql ^
  --auth.provider StaticWebApps ^
  --runtime.base-route /v1

Resulterende configuratie

{
  "runtime": {
    "base-route": "/v1"
  }
}

--set-session-context

Schakel het verzenden van gegevens naar SQL Server in met behulp van sessiecontext. Alleen geldig voor mssql. De standaardinstelling is false.

Example

dab init \
  --database-type mssql \
  --set-session-context true

dab init ^
  --database-type mssql ^
  --set-session-context true

Resulterende configuratie

{
  "data-source": {
    "database-type": "mssql",
    "options": {
      "set-session-context": true
    }
  }
}