Data API builder documentation

Data API builder (DAB) provides a REST API over a database. It also provides a GraphQL API. It supports not just SQL Server, but Azure SQL Database, Azure Cosmos DB, PostgreSQL, MySQL, and SQL Data Warehouse. DAB runs in any cloud or on-premises, and it's open source and free to use. It's secure, feature-rich, and a foundational component of Microsoft Fabric—which is another way of saying it's high-performance and capable of handling massive data operations.

About Data API builder

Overview

• What is Data API builder?
• Feature availability
• Frequently asked questions

What's new

• Version 1.7
• Version 1.6
• Version 1.5
• Version 1.4
• Version 1.3
• All versions

Training

• SQL Learning Path

Get started

Quickstart

• DAB with SQL Server
• DAB with Azure SQL
• DAB with Azure Cosmos DB for NoSQL

Quickstart

• DAB with PostgreSQL
• DAB with MySQL

video

• DAB basics 101
• DAB system walkthrough
• The DAB Visual Studio Code extension
• DAB and the Command Query Responsibility Segregation (CQRS) pattern
• DAB and how it works
• DAB and .NET Aspire

Open Source

Download

• NuGet package
• MCR container
• VS Code extension

Reference

• Code Repository
• Open Issues
• Feature Backlog
• Open-source software (OSS) license
• Discussions

sample

• Samples

Developer Reference

Reference

• Configuration syntax
• Feature availability
• Code Policies
• Aggregate data with GraphQL

Concept

• Database Views
• Stored Procedures
• Table Relationships

How-To Guide

• Set up Azure Cosmos DB

sample

• Library app sample with Data API builder, SQL Server, and Blazor
• Todo app sample with Data API builder and Azure SQL
• Library app sample with Data API builder and Azure SQL
• Sample devcontainer for Data API builder and Azure SQL Database

Deploy

• Azure Container Instances
• Azure Container Apps

REST API

Concept

• REST endpoints
• OpenAPI documents

How-To Guide

• If-Match Header
• Location Header
• Cache-Control Header

Reference

• Field projection
• Pagination
• Record filtering

GraphQL API

Concept

• GraphQL endpoints
• OpenAPI documents

Reference

• Field projection
• Pagination
• Record filtering

Configuration File

Concept

• Schema Reference
• File Environments
• Env() Function
• Multiple Data Sources
• Best Practices

Command Line

Concept

• Overview

How-To Guide

• Installation

Reference

• dab add
• dab configure
• dab export
• dab init
• dab start
• dab update
• dab validate

Visual Studio Code extensions

Overview

• Visual Studio Code extensions overview

How-To Guide

• DAB Init extension
• DAB Add extension
• DAB Start extension
• DAB Validate extension

Download

• DAB Omnibus in Visual Studio Marketplace

Logs and Monitoring

Concept

• Application Insights
• Health Checks
• Log Levels
• OpenTelemetry

API-level Security

Concept

• Security Overview
• Authorization and roles

How-To Guide

• Configure Entra ID authentication
• Configure custom JSON Web Token (JWT) authentication (Okta/Auth0)
• Configure App Service authentication
• Configure Simulator for testing
• Implement row-level security

Reference

• Security best practices

Data Caching

Concept

• Level 1 Cache
• Level 2 Cache

Reference

• Cache HTTP headers