EntityGraphQL.AspNet
1.1.0-beta1
See the version list below for details.
dotnet add package EntityGraphQL.AspNet --version 1.1.0-beta1
NuGet\Install-Package EntityGraphQL.AspNet -Version 1.1.0-beta1
<PackageReference Include="EntityGraphQL.AspNet" Version="1.1.0-beta1" />
paket add EntityGraphQL.AspNet --version 1.1.0-beta1
#r "nuget: EntityGraphQL.AspNet, 1.1.0-beta1"
// Install EntityGraphQL.AspNet as a Cake Addin #addin nuget:?package=EntityGraphQL.AspNet&version=1.1.0-beta1&prerelease // Install EntityGraphQL.AspNet as a Cake Tool #tool nuget:?package=EntityGraphQL.AspNet&version=1.1.0-beta1&prerelease
Entity GraphQL
A GraphQL library for .NET Core
Jump into the https://entitygraphql.github.io/ for documentation and to get started.
Entity GraphQL is a .NET Core (netstandard 2.1) library that allows you to easily build a GraphQL API on top of your data with the extensibility to bring multiple data sources together in the single GraphQL schema.
It can also be used to execute simple LINQ-style expressions at runtime against a given object which provides powerful runtime configuration.
Please explore, give feedback or join the development.
If you're looking for a dotnet library to generate code to query an API from a GraphQL schema see https://github.com/lukemurray/DotNetGraphQLQueryGen
Installation
Via Nuget
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 DemoContext(DbContextOptions options) : base(options)
{
}
protected override void OnModelCreating(ModelBuilder builder) {
// Set up your relations
}
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);
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 is compatible. 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 was computed. 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.1 is compatible. |
-
.NETCoreApp 3.1
- EntityGraphQL (>= 1.1.0-beta1)
- Microsoft.AspNetCore.Authorization (>= 3.1.22)
-
net5.0
- EntityGraphQL (>= 1.1.0-beta1)
- Microsoft.AspNetCore.Authorization (>= 5.0.13)
-
net6.0
- EntityGraphQL (>= 1.1.0-beta1)
- Microsoft.AspNetCore.Authorization (>= 6.0.1)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on EntityGraphQL.AspNet:
Package | Downloads |
---|---|
Dino.GraphqlLib
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on EntityGraphQL.AspNet:
Repository | Stars |
---|---|
SapiensAnatis/Dawnshard
Server emulator for Dragalia Lost
|
Version | Downloads | Last updated |
---|---|---|
5.5.3 | 1,894 | 11/24/2024 |
5.5.2 | 785 | 11/15/2024 |
5.5.1 | 90 | 11/14/2024 |
5.5.0 | 909 | 10/25/2024 |
5.4.6 | 5,065 | 9/23/2024 |
5.4.5 | 846 | 9/13/2024 |
5.4.4 | 133 | 9/12/2024 |
5.4.3 | 1,305 | 9/3/2024 |
5.4.2 | 201 | 9/2/2024 |
5.4.1 | 4,149 | 7/15/2024 |
5.4.0 | 4,302 | 6/2/2024 |
5.3.0 | 5,365 | 5/7/2024 |
5.2.1 | 4,115 | 4/8/2024 |
5.2.0 | 4,692 | 3/19/2024 |
5.2.0-beta2 | 454 | 2/11/2024 |
5.2.0-beta1 | 2,693 | 11/16/2023 |
5.1.1 | 4,682 | 1/24/2024 |
5.1.0 | 4,792 | 11/16/2023 |
5.0.1 | 4,645 | 9/28/2023 |
5.0.0 | 2,365 | 8/2/2023 |
5.0.0-beta1 | 331 | 6/17/2023 |
4.3.1 | 154 | 11/22/2023 |
4.3.0 | 6,215 | 3/14/2023 |
4.2.1 | 1,836 | 12/22/2022 |
4.2.0 | 1,214 | 11/16/2022 |
4.1.2 | 663 | 10/20/2022 |
4.1.1 | 603 | 10/18/2022 |
4.1.0 | 571 | 10/13/2022 |
4.0.1 | 1,004 | 10/5/2022 |
4.0.0 | 1,550 | 9/10/2022 |
4.0.0-beta2 | 618 | 9/8/2022 |
4.0.0-beta1 | 168 | 9/6/2022 |
3.0.5 | 819 | 8/16/2022 |
3.0.4 | 568 | 8/6/2022 |
3.0.3 | 1,076 | 8/4/2022 |
3.0.2 | 758 | 8/1/2022 |
3.0.1 | 437 | 8/1/2022 |
3.0.0 | 583 | 7/31/2022 |
2.3.2 | 511 | 7/18/2022 |
2.3.1 | 881 | 7/14/2022 |
2.3.0 | 701 | 7/4/2022 |
2.2.0 | 488 | 7/1/2022 |
2.1.5 | 1,957 | 6/13/2022 |
2.1.4 | 447 | 6/11/2022 |
2.1.3 | 1,010 | 6/6/2022 |
2.1.2 | 572 | 5/23/2022 |
2.1.1 | 764 | 5/18/2022 |
2.1.0 | 475 | 5/17/2022 |
2.0.3 | 491 | 5/9/2022 |
2.0.2 | 505 | 5/6/2022 |
2.0.1 | 492 | 5/5/2022 |
2.0.0 | 503 | 4/29/2022 |
2.0.0-beta7 | 175 | 4/27/2022 |
2.0.0-beta6 | 165 | 4/25/2022 |
2.0.0-beta5 | 169 | 4/14/2022 |
2.0.0-beta4 | 186 | 4/13/2022 |
2.0.0-beta3 | 164 | 4/13/2022 |
2.0.0-beta2 | 181 | 4/11/2022 |
2.0.0-beta1 | 181 | 4/7/2022 |
1.2.1 | 7,150 | 2/20/2022 |
1.2.0 | 501 | 2/15/2022 |
1.1.2 | 476 | 2/11/2022 |
1.1.1 | 699 | 2/9/2022 |
1.1.0 | 635 | 1/13/2022 |
1.1.0-beta2 | 197 | 1/8/2022 |
1.1.0-beta1 | 184 | 1/8/2022 |
1.0.2 | 556 | 10/20/2021 |
1.0.1 | 12,112 | 9/30/2021 |
1.0.0 | 432 | 9/28/2021 |
1.0.0-beta2 | 225 | 9/15/2021 |