EntityGraphQL 5.5.0
dotnet add package EntityGraphQL --version 5.5.0
NuGet\Install-Package EntityGraphQL -Version 5.5.0
<PackageReference Include="EntityGraphQL" Version="5.5.0" />
paket add EntityGraphQL --version 5.5.0
#r "nuget: EntityGraphQL, 5.5.0"
// Install EntityGraphQL as a Cake Addin #addin nuget:?package=EntityGraphQL&version=5.5.0 // Install EntityGraphQL as a Cake Tool #tool nuget:?package=EntityGraphQL&version=5.5.0
Entity GraphQL
A GraphQL library for .NET Core
Head to entitygraphql.github.io for documentation and to get started.
EntityGraphQL is a .NET library that allows you to easily build a GraphQL API on top of your data model with the extensibility to easily bring multiple data sources together in the single GraphQL schema.
EntityGraphQL builds a GraphQL schema that maps to .NET objects. It provides the functionality to parse a GraphQL query document and execute that against your mapped objects. These objects can be an Entity Framework DbContext
or any other .NET object, it doesn't matter.
A core feature of EntityGraphQL with Entity Framework (although EF is not a requirement) is that it builds selections of only the fields requested in the GraphQL query which means Entity Framework is not returning all columns from a table. This is done with the LINQ projection operator Select()
hence it works across any object tree.
Please explore, give feedback or join the development.
Installation
The EntityGraphQL.AspNet package will get you easily set up with ASP.NET.
However the core EntityGraphQL package has no ASP.NET dependency.
Quick Start with Entity Framework
Note: There is no dependency on EF. Queries are compiled to IQueryable
or IEnumberable
linq expressions. EF is not a requirement - any ORM working with LinqProvider
or an in-memory object will work - although EF well is tested.
1. Define your data context (in this example an EF context)
public class DemoContext : DbContext {
public DbSet<Property> Properties { get; set; }
public DbSet<PropertyType> PropertyTypes { get; set; }
public DbSet<Location> Locations { get; set; }
}
public class Property {
public uint Id { get; set; }
public string Name { get; set; }
public PropertyType Type { get; set; }
public Location Location { get; set; }
}
public class PropertyType {
public uint Id { get; set; }
public string Name { get; set; }
public decimal Premium { get; set; }
}
public class Location {
public uint Id { get; set; }
public string Name { get; set; }
}
2. Create a route
Here is an example for a ASP.NET. You will also need to install EntityGraphQL.AspNet to use MapGraphQL
. You can also build you own endpoint, see docs.
public class Startup {
public void ConfigureServices(IServiceCollection services)
{
services.AddDbContext<DemoContext>(opt => opt.UseInMemoryDatabase());
// This registers a SchemaProvider<DemoContext>
services.AddGraphQLSchema<DemoContext>();
}
public void Configure(IApplicationBuilder app, DemoContext db)
{
app.UseRouting();
app.UseEndpoints(endpoints =>
{
// default to /graphql endpoint
endpoints.MapGraphQL<DemoContext>();
});
}
}
This sets up 1 end point:
POST
at/graphql
where the body of the post is a GraphQL query- You can authorize that route how you would any ASP.NET route. See Authorization below for details on having parts of the schema requiring Authorization/Claims
Note - As of version 1.1+ the EntityGraphQL.AspNet extension helper uses System.Text.Json. Previous versions used JSON.NET.
3. Build awesome applications
You can now make a request to your API. For example
POST localhost:5000/graphql
{
properties { id name }
}
Will return the following result.
{
"data": {
"properties": [
{
"id": 11,
"name": "My Beach Pad"
},
{
"id": 12,
"name": "My Other Beach Pad"
}
]
}
}
Maybe you only want a specific property
{
property(id: 11) {
id name
}
}
Will return the following result.
{
"data": {
"property": {
"id": 11,
"name": "My Beach Pad"
}
}
}
If you need a deeper graph or relations, just ask
{
properties {
id
name
location {
name
}
type {
premium
}
}
}
Will return the following result.
{
"data": {
"properties": [
{
"id": 11,
"name": "My Beach Pad",
"location": {
"name": "Greece"
},
"type": {
"premium": 1.2
}
},
{
"id": 12,
"name": "My Other Beach Pad",
"location": {
"name": "Spain"
},
"type": {
"premium": 1.25
}
}
]
}
}
Visit documentation for more information.
Using expressions else where (EQL)
Lets say you have a screen in your application listing properties that can be configured per customer or user to only show exactly what they are interested in. Instead of having a bunch of checkboxes and complex radio buttons etc. you can allow a simple EQL statement to configure the results shown. Or use those UI components to build the query.
// This might be a configured EQL statement for filtering the results. It has a context of Property
(type.id = 2) or (type.id = 3) and type.name = "Farm"
This would compile to (Property p) => (p.Type.Id == 2 || p.Type.Id == 3) && p.Type.Name == "Farm";
This can then be used in various Linq functions either in memory or against an ORM.
// we create a schema provider to compile the statement against our Property type
var schemaProvider = SchemaBuilder.FromObject<Property>();
var compiledResult = EntityQueryCompiler.Compile(myConfigurationEqlStatement, schemaProvider);
// you get your list of Properties from you DB
var thingsToShow = myProperties.Where(compiledResult.LambdaExpression);
Another example is you want a customised calculated field. You can execute a compiled result passing in an instance of the context type.
// You'd take this from some configuration
var eql = @"if location.name = ""Mars"" then (cost + 5) * type.premium else (cost * type.premium) / 3"
var compiledResult = EntityQueryCompiler.Compile(eql, schemaProvider);
var theRealPrice = compiledResult.Execute<decimal>(myPropertyInstance);
Versioning
We do our best to follow Semantic Versioning:
Given a version number MAJOR.MINOR.PATCH
, an increment in:
MAJOR
version is when we make incompatible API changes,MINOR
version is when we add functionality in a backwards compatible manner, andPATCH
version is when we make backwards compatible bug fixes.
Contribute & Join the Development
Please do. Pull requests are very welcome. See the open issues for bugs or features that would be useful.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- HotChocolate.Language (>= 13.9.11)
- Humanizer.Core (>= 2.14.1)
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Parlot (>= 1.0.2)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Runtime.Caching (>= 8.0.1)
- System.Text.Json (>= 8.0.5)
-
net6.0
- HotChocolate.Language (>= 13.9.11)
- Humanizer.Core (>= 2.14.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Parlot (>= 1.0.2)
- System.Runtime.Caching (>= 8.0.1)
-
net8.0
- HotChocolate.Language (>= 13.9.11)
- Humanizer.Core (>= 2.14.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Parlot (>= 1.0.2)
- System.Runtime.Caching (>= 8.0.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on EntityGraphQL:
Package | Downloads |
---|---|
EntityGraphQL.AspNet
Contains ASP.NET extensions and middleware for EntityGraphQL |
|
Zen.Web.GraphQL
Package Description |
|
SiteCauldron.GenericAPI
SiteCauldron Generic API utilities for Web MVC applications. Provides a few controllers to cover most use cases, so that you mostly won't have to program a CRUD again. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on EntityGraphQL:
Repository | Stars |
---|---|
SapiensAnatis/Dawnshard
Server emulator for Dragalia Lost
|
Version | Downloads | Last updated |
---|---|---|
5.5.0 | 310 | 10/25/2024 |
5.4.6 | 2,923 | 9/23/2024 |
5.4.5 | 875 | 9/13/2024 |
5.4.4 | 152 | 9/12/2024 |
5.4.3 | 1,529 | 9/3/2024 |
5.4.2 | 199 | 9/2/2024 |
5.4.1 | 6,323 | 7/15/2024 |
5.4.0 | 3,728 | 6/2/2024 |
5.3.0 | 4,269 | 5/7/2024 |
5.2.1 | 4,113 | 4/8/2024 |
5.2.0 | 4,824 | 3/19/2024 |
5.2.0-beta2 | 626 | 2/11/2024 |
5.2.0-beta1 | 2,678 | 11/16/2023 |
5.1.1 | 11,540 | 1/24/2024 |
5.1.0 | 6,689 | 11/16/2023 |
5.0.1 | 4,920 | 9/28/2023 |
5.0.0 | 3,073 | 8/2/2023 |
5.0.0-beta1 | 865 | 6/17/2023 |
4.3.1 | 520 | 11/22/2023 |
4.3.0 | 7,199 | 3/14/2023 |
4.2.1 | 13,594 | 12/22/2022 |
4.2.0 | 5,877 | 11/16/2022 |
4.1.2 | 2,034 | 10/20/2022 |
4.1.1 | 1,393 | 10/18/2022 |
4.1.0 | 1,341 | 10/13/2022 |
4.0.1 | 1,739 | 10/5/2022 |
4.0.0 | 2,376 | 9/10/2022 |
4.0.0-beta2 | 1,189 | 9/8/2022 |
4.0.0-beta1 | 784 | 9/6/2022 |
3.0.5 | 1,667 | 8/16/2022 |
3.0.4 | 1,334 | 8/5/2022 |
3.0.3 | 1,768 | 8/4/2022 |
3.0.2 | 1,481 | 8/1/2022 |
3.0.1 | 1,210 | 8/1/2022 |
3.0.0 | 1,344 | 7/31/2022 |
2.3.2 | 1,486 | 7/18/2022 |
2.3.1 | 1,656 | 7/14/2022 |
2.3.0 | 1,559 | 7/4/2022 |
2.2.0 | 3,376 | 7/1/2022 |
2.1.5 | 3,141 | 6/13/2022 |
2.1.4 | 1,234 | 6/11/2022 |
2.1.3 | 1,792 | 6/6/2022 |
2.1.2 | 1,353 | 5/23/2022 |
2.1.1 | 1,573 | 5/18/2022 |
2.1.0 | 1,237 | 5/17/2022 |
2.0.3 | 1,245 | 5/9/2022 |
2.0.2 | 1,327 | 5/6/2022 |
2.0.1 | 1,241 | 5/5/2022 |
2.0.0 | 1,338 | 4/29/2022 |
2.0.0-beta7 | 702 | 4/27/2022 |
2.0.0-beta6 | 694 | 4/25/2022 |
2.0.0-beta5 | 2,143 | 4/14/2022 |
2.0.0-beta4 | 797 | 4/13/2022 |
2.0.0-beta3 | 754 | 4/13/2022 |
2.0.0-beta2 | 794 | 4/11/2022 |
2.0.0-beta1 | 6,120 | 4/7/2022 |
1.2.0 | 17,690 | 2/15/2022 |
1.1.2 | 1,281 | 2/11/2022 |
1.1.1 | 1,346 | 2/9/2022 |
1.1.0 | 2,688 | 1/13/2022 |
1.1.0-beta2 | 738 | 1/8/2022 |
1.1.0-beta1 | 716 | 1/8/2022 |
1.0.3 | 833 | 12/28/2021 |
1.0.2 | 8,091 | 10/20/2021 |
1.0.1 | 13,604 | 9/30/2021 |
1.0.0 | 1,094 | 9/28/2021 |
1.0.0-beta2 | 811 | 9/15/2021 |
1.0.0-beta1 | 759 | 9/13/2021 |
0.70.0 | 3,870 | 8/30/2021 |
0.69.0 | 1,403 | 8/18/2021 |
0.69.0-beta7 | 779 | 8/12/2021 |
0.69.0-beta6 | 811 | 8/10/2021 |
0.69.0-beta5 | 764 | 8/9/2021 |
0.69.0-beta4 | 814 | 8/6/2021 |
0.69.0-beta3 | 801 | 8/5/2021 |
0.69.0-beta2 | 1,420 | 7/24/2021 |
0.69.0-beta1 | 856 | 7/16/2021 |
0.68.1 | 2,262 | 4/5/2021 |
0.66.1 | 13,741 | 10/5/2020 |
0.66.0 | 1,308 | 9/22/2020 |
0.65.0 | 1,139 | 9/17/2020 |
0.64.0 | 1,714 | 9/1/2020 |
0.63.0 | 1,828 | 6/10/2020 |
0.63.0-beta3 | 1,930 | 6/4/2020 |
0.63.0-beta2 | 939 | 6/4/2020 |
0.63.0-beta1 | 956 | 6/3/2020 |
0.62.0 | 1,241 | 5/27/2020 |
0.61.0 | 1,145 | 5/14/2020 |
0.60.0 | 1,153 | 5/9/2020 |
0.60.0-beta3 | 1,293 | 5/4/2020 |
0.60.0-beta1 | 1,180 | 4/22/2020 |
0.50.0 | 3,933 | 4/1/2020 |
0.50.0-beta1 | 1,023 | 3/24/2020 |
0.40.0 | 1,330 | 3/19/2020 |
0.32.1 | 1,699 | 3/3/2020 |
0.32.0 | 1,755 | 2/14/2020 |
0.31.0 | 1,507 | 2/6/2020 |
0.30.0 | 2,331 | 1/23/2020 |
0.29.0 | 1,171 | 1/21/2020 |
0.28.1 | 1,547 | 1/8/2020 |
0.28.0 | 1,300 | 1/8/2020 |
0.27.2 | 1,165 | 1/8/2020 |
0.27.1 | 1,181 | 1/7/2020 |
0.27.0 | 1,190 | 1/6/2020 |
0.26.0 | 5,021 | 1/2/2020 |
0.25.0 | 1,845 | 11/19/2019 |
0.24.0 | 1,228 | 11/12/2019 |
0.23.3 | 1,249 | 11/4/2019 |
0.23.2 | 1,234 | 11/2/2019 |
0.23.1 | 1,217 | 10/31/2019 |
0.23.0 | 1,188 | 10/30/2019 |
0.22.0 | 1,204 | 10/30/2019 |
0.21.0 | 2,498 | 9/3/2019 |
0.20.1 | 1,246 | 8/28/2019 |
0.20.0 | 1,197 | 8/28/2019 |
0.19.1 | 1,307 | 8/26/2019 |
0.19.0 | 1,207 | 8/25/2019 |
0.18.4 | 1,345 | 8/19/2019 |
0.18.3 | 1,372 | 7/30/2019 |
0.18.2 | 1,466 | 7/26/2019 |
0.18.1 | 1,326 | 7/18/2019 |
0.18.0 | 1,325 | 7/17/2019 |
0.17.0 | 1,490 | 7/8/2019 |
0.16.2 | 1,787 | 6/1/2019 |
0.16.1 | 1,370 | 5/27/2019 |
0.16.0 | 1,427 | 5/21/2019 |
0.15.8 | 1,502 | 4/11/2019 |
0.15.7 | 1,338 | 4/11/2019 |
0.15.6 | 10,483 | 3/15/2019 |
0.15.5 | 1,314 | 3/14/2019 |
0.15.4 | 1,348 | 3/8/2019 |
0.15.3 | 1,347 | 3/6/2019 |
0.15.2 | 1,367 | 2/22/2019 |
0.15.1 | 1,637 | 2/14/2019 |
0.15.0 | 1,464 | 2/5/2019 |
0.14.4 | 1,498 | 1/29/2019 |
0.14.3 | 1,444 | 1/25/2019 |
0.14.2 | 1,399 | 1/22/2019 |
0.14.1 | 1,421 | 1/21/2019 |
0.14.0 | 1,481 | 1/14/2019 |
0.13.1 | 1,449 | 1/9/2019 |
0.13.0 | 1,434 | 1/3/2019 |
0.12.1 | 1,528 | 12/18/2018 |
0.12.0 | 1,405 | 12/13/2018 |
0.11.0 | 1,503 | 11/13/2018 |