Compartilhar via

init comando

Inicialize um novo arquivo de configuração do construtor de API de dados. O JSON resultante captura detalhes da fonte de dados, pontos de extremidade habilitados (REST, GraphQL, MCP), autenticação e comportamentos de runtime.

Sintaxe

dab init [options]

Se o arquivo de configuração de destino já existir, o comando o substituirá. Não há mesclagem. Use o controle de versão ou backups se precisar preservar o arquivo anterior.

Olhar rápido

Opção Resumo
-c, --config Nome do arquivo de configuração de saída (dab-config.jsonpadrão)

Authentication

Opção Resumo
--auth.audience Declaração de audiência JWT
--auth.issuer Declaração do emissor JWT
--auth.provider Provedor de identidade (StaticWebApps padrão)

Fonte de dados

Opção Resumo
--connection-string Cadeia de conexão de banco de dados (dá @env()suporte)
--cosmosdb_nosql-container Nome do contêiner NoSQL do Cosmos DB (opcional)
--cosmosdb_nosql-database Nome do banco de dados NoSQL do Cosmos DB (necessário para cosmosdb_nosql)
--database-type Tipo de banco de dados: mssql, mysql, , postgresql, , cosmosdb_postgresqlcosmosdb_nosql
--set-session-context Habilitar o contexto de sessão do SQL Server (somente mssql)

GraphQL

Opção Resumo
--graphql.disabled Preterido. Desabilita GraphQL (use --graphql.enabled false)
--graphql.enabled Habilitar o GraphQL (true padrão)
--graphql.multiple-create.enabled Permitir várias mutações de criação (falso padrão)
--graphql.path Prefixo do ponto de extremidade graphQL (padrão /graphql)
--graphql-schema Caminho para o esquema GraphQL (necessário para cosmosdb_nosql)

Host e autenticação

Opção Resumo
--host-mode Modo de host: desenvolvimento ou produção (produção padrão)
--cors-origin Lista de origens permitida (separada por vírgulas)
--runtime.base-route Prefixo global para todos os pontos de extremidade

MCP

Opção Resumo
--mcp.disabled Preterido. Desabilita o MCP (usar --mcp.enabled false)
--mcp.enabled Habilitar MCP (true padrão)
--mcp.path Prefixo do ponto de extremidade MCP (padrão /mcp)

Observação

A funcionalidade do MCP fará parte da versão 1.7.

REST

Opção Resumo
--rest.disabled Preterido. Desabilita REST (usar --rest.enabled false)
--rest.enabled Habilitar REST (padrão true, preferir mais --rest.disabled)
--rest.path Prefixo do ponto de extremidade REST (padrão /api, ignorado para cosmosdb_nosql)
--rest.request-body-strict Impor a validação estrita do corpo da solicitação (true padrão, ignorado para cosmosdb_nosql)

Importante

Não misture os novos --*.enabled sinalizadores e os sinalizadores herdados --*.disabled para o mesmo subsistema no mesmo comando. Prefira o --*.enabled padrão; os --rest.disabled--graphql.disabledavisos de log de opções e --mcp.disabled opções e serão removidos em versões futuras.

-c, --config

Nome do arquivo de configuração de saída. O padrão é dab-config.json.

Example

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

Configuração resultante

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('MSSQL_CONNECTION_STRING')"
  }
}

--auth.audience

Declaração de audiência JWT.

Example

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

Configuração resultante

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

--auth.issuer

Declaração do emissor JWT.

Example

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

Configuração resultante

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

--auth.provider

Provedor de identidade. O padrão é StaticWebApps.

Example

dab init --database-type mssql --auth.provider AzureAD

Configuração resultante

{
  "runtime": {
    "authentication": {
      "provider": "AzureAD"
    }
  }
}

--connection-string

Cadeia de conexão de banco de dados. Suporta @env().

Example

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

Configuração resultante

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

--cors-origin

Lista separada por vírgulas de origens permitidas.

Example

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

Configuração resultante

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

--cosmosdb_nosql-container

Nome do contêiner NoSQL do Cosmos DB.

Example

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

Configuração resultante

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

--cosmosdb_nosql-database

Nome do banco de dados NoSQL do Cosmos DB. Necessário para cosmosdb_nosql.

Example

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

Configuração resultante

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

--database-type

Especifica o mecanismo de banco de dados de destino. Valores com suporte: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init --database-type mssql

Configuração resultante

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

--graphql.disabled

Preterido. Desabilita o GraphQL. Preferir --graphql.enabled false.

--graphql.enabled

Habilite o ponto de extremidade do GraphQL. O padrão é true.

Example

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

Configuração resultante

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

--graphql.multiple-create.enabled

Permite a criação de várias linhas em uma única mutação. O padrão é false.

Example

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

Configuração resultante

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

--graphql.path

Prefixo do ponto de extremidade do GraphQL. O padrão é /graphql.

Example

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

Configuração resultante

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

--graphql-schema

Caminho para um arquivo de esquema graphQL. Necessário para cosmosdb_nosql.

Example

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

Configuração resultante

{
  "runtime": {
    "graphql": {
      "schema": "./schema.gql"
    }
  }
}

--host-mode

Modo de host. O padrão é Production.

Valores válidos: Development, Production.

Example

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

Configuração resultante

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

--mcp.disabled

Preterido. Desabilita o MCP. Preferir --mcp.enabled false.

--mcp.enabled

Habilite o ponto de extremidade do MCP. O padrão é true.

Example

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

Configuração resultante

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

--mcp.path

Prefixo de ponto de extremidade MCP. O padrão é /mcp.

Example

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

Configuração resultante

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

--rest.disabled

Preterido. Desabilita REST. Preferir --rest.enabled false.

--rest.enabled

Habilite o ponto de extremidade REST. O padrão é true.

Example

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

Configuração resultante

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

--rest.path

Prefixo do ponto de extremidade REST. O padrão é /api.

Observação

Ignorado para cosmosdb_nosql.

Example

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

Configuração resultante

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

--rest.request-body-strict

Controla o tratamento de campos extras em corpos de solicitação. O padrão é true.

  • true: rejeita campos desnecessários (HTTP 400).
  • false: ignora campos extras.

Observação

Ignorado para cosmosdb_nosql.

Example

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

Configuração resultante

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

--runtime.base-route

Prefixo global anexado a todos os pontos de extremidade. Deve começar com /.

Example

dab init --database-type mssql --runtime.base-route /v1

Configuração resultante

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

--set-session-context

Habilite o envio de dados para o SQL Server usando o contexto de sessão. Somente válido para mssql. O padrão é false.

Example

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

Configuração resultante

{
  "runtime": {
    "mssql": {
      "set-session-context": true
    }
  }
}
  • Last updated on