Поделиться через


Команда init

Инициализировать новый файл конфигурации построителя данных API. Результирующий json записывает сведения о источнике данных, включенные конечные точки (REST, GraphQL, MCP), проверку подлинности и поведение среды выполнения.

Синтаксис

dab init [options]

Если целевой файл конфигурации уже существует, команда перезаписывает ее. Нет слияния. Используйте управление версиями или резервные копии, если необходимо сохранить предыдущий файл.

Краткий обзор

Вариант Сводка
-c, --config Имя файла конфигурации вывода (по умолчанию dab-config.json)

Authentication

Вариант Сводка
--auth.audience Утверждение аудитории JWT
--auth.issuer Утверждение издателя JWT
--auth.provider Поставщик удостоверений (по умолчанию StaticWebApps)

Источник данных

Вариант Сводка
--connection-string Строка подключения к базе данных (поддерживается @env())
--cosmosdb_nosql-container Имя контейнера NoSQL Cosmos DB (необязательно)
--cosmosdb_nosql-database Имя базы данных NoSQL Cosmos DB (требуется для cosmosdb_nosql)
--database-type Тип базы данных: mssql, mysql, cosmosdb_postgresqlpostgresqlcosmosdb_nosql
--set-session-context Включение контекста сеанса SQL Server (только mssql)

GraphQL

Вариант Сводка
--graphql.disabled Устарело. Отключает GraphQL (используйте --graphql.enabled false)
--graphql.enabled Включение GraphQL (по умолчанию true)
--graphql.multiple-create.enabled Разрешить несколько изменений создания (по умолчанию false)
--graphql.path Префикс конечной точки GraphQL (по умолчанию /graphql)
--graphql-schema Путь к схеме GraphQL (требуется для cosmosdb_nosql)

Узел и проверка подлинности

Вариант Сводка
--host-mode Режим узла: разработка или рабочая среда (по умолчанию)
--cors-origin Список разрешенных источников (разделенные запятыми)
--runtime.base-route Глобальный префикс для всех конечных точек

MCP

Вариант Сводка
--mcp.disabled Устарело. Отключает MCP (используйте --mcp.enabled false)
--mcp.enabled Включение MCP (по умолчанию true)
--mcp.path Префикс конечной точки MCP (по умолчанию /mcp)

Замечание

Возможность MCP будет частью версии 1.7.

REST

Вариант Сводка
--rest.disabled Устарело. Отключает REST (используйте --rest.enabled false)
--rest.enabled Включить REST (по умолчанию true, предпочесть больше --rest.disabled)
--rest.path Префикс конечной точки REST (по умолчанию /api, игнорируемый для cosmosdb_nosql)
--rest.request-body-strict Принудительное применение строгой проверки текста запроса (по умолчанию true, игнорируемое для cosmosdb_nosql)

Это важно

Не смешивайте новые --*.enabled флаги и устаревшие --*.disabled флаги для той же подсистемы в той же команде. --*.enabled Предпочитайте шаблон, --rest.disabled--graphql.disabledа также предупреждения журнала параметров и --mcp.disabled будут удалены в будущих версиях.

-c, --config

Имя файла конфигурации вывода. По умолчанию — dab-config.json.

Example

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

Результирующая конфигурация

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

--auth.audience

Утверждение аудитории JWT.

Example

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

Результирующая конфигурация

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

--auth.issuer

Утверждение издателя JWT.

Example

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

Результирующая конфигурация

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

--auth.provider

Поставщик удостоверений. По умолчанию — StaticWebApps.

Example

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

Результирующая конфигурация

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

--connection-string

Строка подключения к базе данных. Поддерживает @env().

Example

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

Результирующая конфигурация

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

--cors-origin

Разделенный запятыми список разрешенных источников.

Example

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

Результирующая конфигурация

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

--cosmosdb_nosql-container

Имя контейнера NoSQL Cosmos DB.

Example

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

Результирующая конфигурация

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

--cosmosdb_nosql-database

Имя базы данных NoSQL Cosmos DB. Требуется для cosmosdb_nosql.

Example

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

Результирующая конфигурация

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

--database-type

Указывает целевой ядро СУБД. Поддерживаемые значения: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init --database-type mssql

Результирующая конфигурация

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

--graphql.disabled

Устарело. Отключает GraphQL. Предпочитать --graphql.enabled false.

--graphql.enabled

Включите конечную точку GraphQL. По умолчанию — true.

Example

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

Результирующая конфигурация

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

--graphql.multiple-create.enabled

Разрешает создание нескольких строк в одной мутации. По умолчанию — false.

Example

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

Результирующая конфигурация

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

--graphql.path

Префикс конечной точки GraphQL. По умолчанию — /graphql.

Example

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

Результирующая конфигурация

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

--graphql-schema

Путь к файлу схемы GraphQL. Требуется для cosmosdb_nosql.

Example

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

Результирующая конфигурация

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

--host-mode

Режим узла. По умолчанию — Production.

Допустимые значения: Development, Production.

Example

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

Результирующая конфигурация

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

--mcp.disabled

Устарело. Отключает MCP. Предпочитать --mcp.enabled false.

--mcp.enabled

Включите конечную точку MCP. По умолчанию — true.

Example

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

Результирующая конфигурация

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

--mcp.path

Префикс конечной точки MCP. По умолчанию — /mcp.

Example

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

Результирующая конфигурация

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

--rest.disabled

Устарело. Отключает REST. Предпочитать --rest.enabled false.

--rest.enabled

Включите конечную точку REST. По умолчанию — true.

Example

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

Результирующая конфигурация

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

--rest.path

Префикс конечной точки REST. По умолчанию — /api.

Замечание

Игнорируется для cosmosdb_nosql.

Example

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

Результирующая конфигурация

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

--rest.request-body-strict

Управляет обработкой дополнительных полей в телах запросов. По умолчанию — true.

  • true: отклоняет лишние поля (HTTP 400).
  • false: игнорирует дополнительные поля.

Замечание

Игнорируется для cosmosdb_nosql.

Example

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

Результирующая конфигурация

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

--runtime.base-route

Глобальный префикс, подготовленный ко всем конечным точкам. Должен начинаться с /.

Example

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

Результирующая конфигурация

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

--set-session-context

Включите отправку данных в SQL Server с помощью контекста сеанса. Допустимо только для mssql. По умолчанию — false.

Example

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

Результирующая конфигурация

{
  "runtime": {
    "mssql": {
      "set-session-context": true
    }
  }
}