在這個快速入門中，你會使用 Quickstart 1 SQL 認證範例來在 SQL 上執行 Data API 建構器（DAB）。 使用者可匿名存取網頁應用程式。 該網頁應用程式以匿名方式存取 DAB。 DAB 使用 SQL 認證來連接 SQL Server 或 Azure SQL。
範例透過 REST、GraphQL 和 MCP 暴露 SQL 資料。 它也包含 .NET Aspire 本地編排與 Azure 部署腳本。
Important
SQL 認證讓設定簡單，但它使用儲存的憑證。 避免在生產環境中隱藏秘密。 將本地秘密儲存在 .env，雲端秘密存放在受管理的秘密儲存庫，並考慮為生產工作負載使用受管理身份。
先決條件
- .NET 8 或更高
- Docker 桌面
- PowerShell
- .NET Aspire 工具 用於本地協調
- Azure CLI 用於Azure部署
- 如果你部署資料庫專案，請使用 SQL套件
樣本顯示的內容
- 一個靜態網頁應用程式，無需使用者登入即可呼叫 DAB。
- DAB 被設定為建構於 SQL 之上的唯一 API、GraphQL 與 MCP 層。
- REST、GraphQL 和 MCP 端點皆透過同一個 DAB 設定公開。
- SQL 認證從 DAB 到 本地的 SQL Server，以及 Azure 中的 Azure SQL。
- .NET Aspire 為本地 SQL Server、DAB、網頁應用程式、SQL Commander 及 MCP Inspector 進行編排。
- 在
azure-infra中透過 PowerShell 指令碼部署 Azure。
身份驗證流程
| 跳 | Authentication |
|---|---|
| 使用者對網頁應用程式 | 匿名 |
| 網頁應用程式轉 API | 匿名 |
| API 到 SQL 本地 | SQL 驗證 |
| 適用於 Azure SQL 的 API | SQL 驗證 |
與系列比較
| Step | 改變了什麼 |
|---|---|
| 上一個 | 使用 Data API 建構器搭配 SQL 建立本地 REST 和 GraphQL 端點，搭配 DAB CLI。 |
| 本快速入門 | 使用完整的範例應用程式和 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 開啟。 網頁應用程式會在 http://localhost:5173 開啟。 使用儀表板檢查 DAB 端點、SQL Server 容器、MCP Inspector 和 SQL Commander 資源。
將範例部署到 Azure。
pwsh ./azure-infra/azure-up.ps1
部署腳本會為 Azure SQL 和 Azure 容器應用程式 資源提供 DAB、網頁應用、MCP Inspector 和 SQL Commander。
完成後清理 Azure 資源。
pwsh ./azure-infra/azure-down.ps1
關鍵檔案
| 路徑 | Purpose |
|---|---|
azure-infra |
Bicep 檔案與 PowerShell 腳本用於 Azure 部署與清理。 |
data-api/dab-config.json |
DAB 執行時配置，支援 SQL、REST、GraphQL、MCP 及匿名實體存取。 |
database |
SQL 資料庫專案、結構檔案與種子資料腳本。 |
web-app |
靜態網頁應用程式，可以匿名呼叫 DAB。 |
aspire-apphost |
.NET Aspire AppHost 負責協調本地容器和專案資源。 |
mcp-inspector |
MCP Inspector 容器設定用於測試 DAB 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.