-
Notifications
You must be signed in to change notification settings - Fork 331
Add Core NuGet package authoring requirements #3474
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
RubenCerna2079
wants to merge
2
commits into
main
Choose a base branch
from
dev/rubencerna/add-auth-nuget-package
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+70
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Data API builder Core Library for Azure Databases | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| ## About | ||
|
|
||
| **Microsoft.DataApiBuilder.Core** is the core engine library for [Data API builder](https://learn.microsoft.com/azure/data-api-builder/) (DAB). It provides the runtime components needed to generate and execute secure REST, GraphQL endpoints and MCP tools backed by Azure and other databases. | ||
|
|
||
| This package is intended for developers who want to embed or extend the Data API builder engine within their own .NET applications or services. | ||
|
|
||
| ## Supported Databases | ||
|
|
||
| - Azure SQL / SQL Server | ||
| - Azure SQL Data Warehouse | ||
| - Azure Cosmos DB (NoSQL) | ||
| - PostgreSQL | ||
| - MySQL | ||
|
|
||
| ## Key Capabilities | ||
|
|
||
| - **REST API engine** — Automatically generates CRUD endpoints (POST, GET, PUT, PATCH, DELETE) with filtering, sorting, and pagination | ||
| - **GraphQL engine** — Generates queries and mutations with filtering, sorting, pagination, and relationship navigation | ||
| - **MCP tool support** — Exposes DML and custom MCP tools for building SQL MCP Servers | ||
| - **Authentication** — OAuth2/JWT and EasyAuth (Azure App Service / Static Web Apps) | ||
| - **Authorization** — Role-based access control with item-level security via policy expressions | ||
| - **Configuration-driven** — Define entities, permissions, and relationships in a JSON config file; no code required | ||
| - **Multi-database** — Connect to multiple database types from a single instance | ||
| - **Caching** — Built-in response caching with [FusionCache](https://github.com/ZiggyCreatures/FusionCache) | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| dotnet add package Microsoft.DataApiBuilder.Core | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| This library provides the core services and middleware used by the Data API builder runtime. Register the DAB services in your application's dependency injection container and configure them using a [DAB configuration file](https://learn.microsoft.com/azure/data-api-builder/reference-configuration). | ||
|
|
||
| For a complete, ready-to-run experience, consider using the [`Microsoft.DataApiBuilder`](https://www.nuget.org/packages/Microsoft.DataApiBuilder) NuGet package or the [DAB CLI](https://learn.microsoft.com/azure/data-api-builder/how-to-install-cli). | ||
|
|
||
| ## Resources | ||
|
|
||
| - [Official Documentation](https://learn.microsoft.com/azure/data-api-builder/) | ||
| - [GitHub Repository](https://github.com/Azure/data-api-builder) | ||
| - [Samples](https://aka.ms/dab/samples) | ||
| - [Known Issues](https://learn.microsoft.com/azure/data-api-builder/known-issues) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit:
MCP tools backed by Azure SQL and other databases.