快速入门：将 SQL 身份验证与数据 API 生成器配合使用

在本快速入门中，你将使用 Quickstart 1 SQL 身份验证示例通过 SQL 运行数据 API 生成器（DAB）。 用户匿名访问 Web 应用。 Web 应用匿名访问 DAB。 DAB 使用 SQL 身份验证连接到SQL Server或Azure SQL。

此示例通过 REST、GraphQL 和 MCP 公开 SQL 数据。 它还包括 .NET Aspire 本地编排和 Azure 部署脚本。

Important

SQL 身份验证使设置保持简单，但它使用存储的凭据。 避免在生产环境中嵌入敏感信息。 将本地机密存储在 .env 中，将云端机密存储在托管的机密存储中，并考虑为生产工作负载使用托管标识。

先决条件

示例显示的内容

  • 无需用户登录即可调用 DAB 的静态 Web 应用。
  • DAB 配置为 SQL 上唯一的 API、GraphQL 和 MCP 层。
  • 由同一 DAB 配置公开的 REST、GraphQL 和 MCP 终结点。
  • DAB 到本地 SQL Server 和 Azure 中 Azure SQL 的 SQL 身份验证
  • 用于本地 SQL Server、DAB、Web 应用、SQL Commander 和 MCP Inspector 的 .NET Aspire 编排
  • 在 azure-infra 中通过 PowerShell 脚本进行 Azure 部署。

身份验证流程

跳 Authentication
用户到 Web 应用 匿名
Web应用到 API 匿名
API 到 SQL 本地 SQL 身份验证
用于Azure SQL的 API SQL 身份验证

与该系列比较

Step 哪些更改
上一个 将 Data API Builder 与 SQL 配合使用，使用 DAB CLI 创建本地 REST 和 GraphQL 终结点。
本快速入门 使用完整的示例应用和 SQL 凭据进行 DAB 到 SQL 访问。
下一步 使用托管标识通过使用 DAB 的Azure标识删除Azure SQL密码。

使用样本

克隆示例存储库。

git clone https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_anon-db_sql_auth.git
cd dab-2.0-quickstart-web_anon-api_anon-db_sql_auth

在本地运行示例。

dotnet tool restore
dotnet run --project aspire-apphost

Aspire 仪表板在 http://localhost:15888 打开。 Web 应用程序将在 http://localhost:5173 打开。 使用仪表板检查 DAB 终结点、SQL Server容器、MCP 检查器和 SQL 指挥官资源。

将示例部署到Azure。

pwsh ./azure-infra/azure-up.ps1

部署脚本为 DAB、Web 应用、MCP 检查器和 SQL 指挥官预配Azure SQL和Azure 容器应用资源。

完成后，清理Azure资源。

pwsh ./azure-infra/azure-down.ps1

密钥文件

路径 Purpose
azure-infra 用于 Azure 部署和清理的 Bicep 文件和 PowerShell 脚本。
data-api/dab-config.json 用于 SQL、REST、GraphQL、MCP 和对匿名实体访问的 DAB 运行时配置。
database SQL 数据库项目、架构文件和种子数据脚本。
web-app 匿名调用 DAB 的静态 Web 应用。
aspire-apphost 用于协调本地容器和项目资源的 .NET Aspire AppHost。
mcp-inspector 用于测试 DAB MCP 工具的 MCP 检查器容器配置。

使用GitHub Copilot重新创建此示例

打开要在Visual Studio Code中创建示例的工作区，将GitHub Copilot切换到代理模式，然后粘贴此提示。

You are GitHub Copilot running in agent mode. Recreate the Data API builder Quickstart 1 SQL Authentication sample as a complete, runnable project in the current VS Code workspace under `quickstart-01-sql-authentication`. Build a static web app, Data API builder (DAB), SQL Server locally, Azure SQL in Azure, REST, GraphQL, MCP, .NET Aspire local orchestration, SQL Commander, MCP Inspector, and Azure Container Apps deployment scripts. DAB is the only API, GraphQL, and MCP layer over SQL.

Source repository: https://github.com/Azure-Samples/dab-2.0-quickstart-web_anon-api_anon-db_sql_auth. If internet access is available, inspect or clone this repository before you create files. Reuse and adapt its files as closely as possible, especially `web-app/`, `data-api/`, `database/`, `aspire-apphost/`, `mcp-inspector/`, `azure-infra/`, scripts, and README patterns. The goal is to implement the published quickstart, not to invent a different sample. If the repository differs from this prompt or the current Data API builder docs, prefer the current docs for product behavior.

Minimize user interaction. Use the defaults in this prompt and make reasonable best guesses for noncritical choices. Do not ask for a root folder or project folder name; use the current VS Code workspace and the default subfolder. Ask only when you need approval for resource changes, secrets, permissions, materially higher cost, external account choices, or an ambiguous requirement that affects the architecture.

Start with a short plan and proceed with safe defaults before you create files or run commands. Ask only these questions if the values aren't already available from the environment or prior context:

- Which Azure subscription, primary region, fallback region, and resource group should Azure deployment use? Default fallback region: `westus2` if the primary region can't provision Azure SQL or Container Apps.
- Do you approve creating billable Azure resources if the deployment phase starts?

Use the default demo SQL Database Project unless the user asks for a simple SQL script. Generate a strong SQL password and store it only in local `.env` files or approved cloud secret stores. Use a conventional SQL admin user name such as `sqladmin` unless the target environment requires a different name.

After the answers, show a short checklist and ask for approval before implementation. Include phases for local scaffold, local validation, Azure infrastructure, Azure deployment, validation, and cleanup. Do not run any Azure command that creates or changes resources until the user explicitly approves the exact command set.

After approval, continue working without asking status-check questions. If a command, build, container, endpoint, or validation step fails, inspect the error, adjust the project, rerun the step, and continue. Keep iterating until the sample runs end-to-end or you hit a blocker that requires user action.

Use cost-first Azure defaults. Choose the cheapest option that satisfies the quickstart requirements: use a free Azure SQL database offer when the subscription and region support it; otherwise choose the lowest-cost SQL option that supports the scenario. Use Azure Container Apps consumption, minimal CPU and memory, Basic Azure Container Registry, minimal Log Analytics retention, and no always-on or dedicated plans unless required. Prioritize finishing the project. Treat regional provisioning limits as expected adjustment points, not failures: if the primary region can't provision a required service or free SQL option, use the approved fallback region such as `westus2`, and continue the deployment. Ask the user only when both the primary and fallback regions can't satisfy the requirements, when a change would materially increase cost, when a new permission is required, or when you need approval for Azure commands that create or change resources beyond the already-approved plan. Keep every resource minimal, but make the web interface neat and approachable: small code footprint, responsive layout, clear status messages, accessible labels, and simple styling that is polished rather than austere.

Verify prerequisites and report only missing items: .NET SDK, Docker Desktop running, PowerShell, Azure CLI, `sqlpackage`, .NET Aspire tooling, and the DAB CLI. If the DAB CLI is missing, install or restore it only after the user approves. Use the DAB CLI docs while building: https://learn.microsoft.com/azure/data-api-builder/command-line/.

Use these docs during implementation:

- DAB CLI reference: https://learn.microsoft.com/azure/data-api-builder/command-line/
- `dab init`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-init
- `dab add`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-add
- `dab validate`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-validate
- `dab start`: https://learn.microsoft.com/azure/data-api-builder/command-line/dab-start
- DAB MCP overview: https://learn.microsoft.com/azure/data-api-builder/mcp/overview

Create this structure under the sample folder:

- `azure-infra/` for Bicep, `azure-up.ps1`, `azure-down.ps1`, and post-provision scripts.
- `data-api/` for `dab-config.json` and a DAB Dockerfile that bakes the config into the image for Azure.
- `database/` for a SQL Database Project or idempotent SQL scripts with seed data.
- `web-app/` for static HTML, CSS, and JavaScript that calls DAB anonymously.
- `aspire-apphost/` for the .NET Aspire AppHost.
- `mcp-inspector/` for MCP Inspector notes or container assets.

Handle secrets first. Add `.env`, `**/bin`, and `**/obj` to `.gitignore` before writing secrets. Use `SQL_PASSWORD` for the SQL password and `MSSQL_CONNECTION_STRING` for the DAB connection string. Never print secret values. Use `@env('MSSQL_CONNECTION_STRING')` in `dab-config.json`.

Configure DAB CORS before you start or deploy the web app. Do not leave `runtime.host.cors.origins` as `[]`. Set it to include the exact web app origins, including scheme and port: the local Aspire web origin, such as `http://localhost:5173`, and the deployed Azure Container Apps web FQDN if Azure deployment is approved. Keep `allow-credentials` set to `false` unless the sample explicitly uses browser credentials or cookies. Direct REST, GraphQL, or Swagger requests can succeed even when the browser blocks JavaScript fetch calls, so browser-origin CORS must be configured and validated separately.

Use this DAB CLI workflow and validate after each config change:

```dotnetcli
dab init --database-type mssql --connection-string "@env('MSSQL_CONNECTION_STRING')" --host-mode Development --rest.enabled true --graphql.enabled true --mcp.enabled true
dab add Todos --source dbo.Todos --source.type table --permissions "anonymous:read" --mcp.dml-tools true
dab validate --config data-api/dab-config.json
dab start --config data-api/dab-config.json
```

Use this minimal DAB runtime shape if you write the config directly:

```json
{
	"$schema": "https://dataapibuilder.azureedge.net/schemas/latest/dab.draft.schema.json",
	"data-source": {
		"database-type": "mssql",
		"connection-string": "@env('MSSQL_CONNECTION_STRING')"
	},
	"runtime": {
		"rest": { "enabled": true, "path": "/api" },
		"graphql": { "enabled": true, "path": "/graphql" },
		"mcp": { "enabled": true, "path": "/mcp" },
		"host": { "mode": "development", "cors": { "origins": ["http://localhost:5173"], "allow-credentials": false } }
	},
	"entities": {}
}
```

Use these Aspire patterns from the quickstart skills:

```csharp
var sqlServer = builder.AddSqlServer("sql-server")
		.WithEnvironment("ACCEPT_EULA", "Y")
		.WithDataVolume("sql-data");
var sqlDatabase = sqlServer.AddDatabase("TodoDb");

var sqlDatabaseProject = builder.AddSqlProject<Projects.database>("sql-project")
		.WithReference(sqlDatabase);

var dabServer = builder.AddContainer("data-api", "azure-databases/data-api-builder", "latest")
		.WithImageRegistry("mcr.microsoft.com")
		.WithBindMount(new FileInfo("data-api/dab-config.json").FullName, "/App/dab-config.json", isReadOnly: true)
		.WithEnvironment("MSSQL_CONNECTION_STRING", sqlDatabase)
		.WithHttpEndpoint(targetPort: 5000, name: "http")
		.WithHttpHealthCheck("/health")
		.WaitForCompletion(sqlDatabaseProject);
```

Use `.WaitForCompletion(sqlDatabaseProject)` for DAB and SQL Commander when a SQL project deploys schema. Do not use only `.WaitFor(sqlDatabaseProject)` for a run-to-completion SQL project.

Add SQL Commander exactly enough to work. Use image `jerrynixon/sql-commander:latest`, env var `ConnectionStrings__db`, and ensure the connection string includes `TrustServerCertificate=true`.

```csharp
var sqlCommander = builder.AddContainer("sql-cmdr", "jerrynixon/sql-commander", "latest")
		.WithImageRegistry("docker.io")
		.WithHttpEndpoint(targetPort: 8080, name: "http")
		.WithEnvironment("ConnectionStrings__db", sqlDatabase)
		.WithHttpHealthCheck("/health")
		.WaitForCompletion(sqlDatabaseProject);
```

Add MCP Inspector exactly enough to work with DAB MCP over HTTP. Use Streamable HTTP transport and omit auth only for local development.

```csharp
var mcpInspector = builder.AddMcpInspector("mcp-inspector")
		.WithMcpServer(dabServer, transportType: McpTransportType.StreamableHttp)
		.WithEnvironment("DANGEROUSLY_OMIT_AUTH", "true")
		.WaitFor(dabServer);
```

Also create a VS Code MCP example for local testing:

```json
{
	"servers": {
		"local-dab": { "type": "http", "url": "http://localhost:5000/mcp" }
	}
}
```

For Azure, bake `dab-config.json` into the DAB image. Do not rely on volume mounts in Azure Container Apps.

```dockerfile
FROM mcr.microsoft.com/azure-databases/data-api-builder:latest
COPY dab-config.json /App/dab-config.json
```

Validate before reporting success:

- `dab validate --config data-api/dab-config.json` exits with code 0.
- `dotnet run --project aspire-apphost` starts the complete local environment.
- A direct database query confirms the seeded table exists and contains rows.
- DAB `/health` returns a 2xx response.
- A browser-origin request from each web app origin receives an `Access-Control-Allow-Origin` response header that matches that origin.
- REST returns seeded rows anonymously.
- GraphQL returns seeded rows anonymously.
- MCP Inspector can list DAB tools and call `describe_entities` or an equivalent DAB MCP tool.
- SQL Commander opens from the Aspire dashboard and shows the seeded table.
- The web site returns a successful HTTP response.
- The web app displays data anonymously.
- Azure Container Apps are healthy if deployment is approved.

Do not report final URLs, asset locations, or a success summary until you directly verify database connectivity and query results, a 2xx DAB health response, and a successful web site response. This validation ensures the sample works without requiring the developer to check.

相关内容

  • Last updated on