data-api-builder-config

Guide Data API Builder configuration file structure and validation.

5|1|Updated Feb 9, 2026
One-click install
npx skills add https://github.com/JerryNixon/github-copilot-sql-dab-azure-mcp --skill data-api-builder-config
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: data-api-builder-config
Source: https://github.com/JerryNixon/github-copilot-sql-dab-azure-mcp/tree/main/.github/skills/data-api-builder-config
Command: npx skills add https://github.com/JerryNixon/github-copilot-sql-dab-azure-mcp --skill data-api-builder-config

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance and best practices for configuring Data API Builder (DAB) files, ensuring your API configurations are valid, secure, and efficient.

Core Features & Use Cases

  • Configuration Structure: Understand the schema, data-source, runtime, and entity sections of dab-config.json.
  • Validation & Best Practices: Learn how to validate configurations and apply security, performance, and organizational best practices.
  • Use Case: You need to define a new REST API endpoint for your SQL Server database using DAB. This Skill will guide you through creating the dab-config.json file, defining the data source, specifying entities, and configuring permissions and runtime settings.

Quick Start

Use the data-api-builder-config skill to generate a minimal valid configuration file for Data API Builder.

Frequently Asked Questions about data-api-builder-config

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure a Data API Builder configuration file for a SQL Server REST API?

To configure a Data API Builder REST API, you create a dab-config.json file defining the data-source, runtime settings, entities, and permissions. This Skill guides you through structuring these sections to generate a valid and secure API configuration.

What is the structure of a dab-config.json file for defining GraphQL and REST APIs?

The dab-config.json structure includes data-source for database connectivity, runtime for API behavior, and entities for exposing tables or views via REST and GraphQL. This Skill details how to configure each section to build efficient data APIs.

How do I set up permissions and relationships for entities in Data API Builder?

Permissions and relationships for Data API Builder entities are configured within the dab-config.json file under the entities section. This Skill explains how to define role-based access and entity relationships to secure your GraphQL and REST API endpoints.

Can I use environment-specific Data API Builder configurations for development and production?

Yes, Data API Builder supports multi-file configurations and environment-specific settings for development and production deployments. This Skill outlines how to manage these variations to ensure your dab-config.json remains valid across different deployment targets.

What are the best practices for validating a Data API Builder configuration?

Validating a Data API Builder configuration involves checking the dab-config.json schema, ensuring secure permissions, and optimizing runtime settings. This Skill provides best practices for performance, security, and organizational structure to keep your API efficient.

Does Data API Builder work with both GraphQL and REST API endpoints?

Yes, Data API Builder supports exposing your database entities through both REST and GraphQL endpoints within the runtime section of dab-config.json. This Skill guides you on configuring the JSON schema to enable both API protocols simultaneously.