EntityGraphQL 5.0.1

.NET 6.0 .NET Standard 2.1
dotnet add package EntityGraphQL --version 5.0.1
NuGet\Install-Package EntityGraphQL -Version 5.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EntityGraphQL" Version="5.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EntityGraphQL --version 5.0.1
#r "nuget: EntityGraphQL, 5.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EntityGraphQL as a Cake Addin
#addin nuget:?package=EntityGraphQL&version=5.0.1

// Install EntityGraphQL as a Cake Tool
#tool nuget:?package=EntityGraphQL&version=5.0.1

Entity GraphQL

A GraphQL library for .NET Core

Build

Jump into the https://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 Nuget package will get you easily set up with ASP.NET.

However the core EntityGraphQL Nuget 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 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.

Nuget

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, and
  • PATCH 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 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. 
.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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.1 0 9/28/2023
5.0.0 999 8/2/2023
5.0.0-beta1 385 6/17/2023
4.3.0 4,700 3/14/2023
4.2.1 5,762 12/22/2022
4.2.0 5,381 11/16/2022
4.1.2 1,596 10/20/2022
4.1.1 905 10/18/2022
4.1.0 864 10/13/2022
4.0.1 1,235 10/5/2022
4.0.0 1,915 9/10/2022
4.0.0-beta2 715 9/8/2022
4.0.0-beta1 300 9/6/2022
3.0.5 1,144 8/16/2022
3.0.4 805 8/5/2022
3.0.3 1,293 8/4/2022
3.0.2 969 8/1/2022
3.0.1 754 8/1/2022
3.0.0 888 7/31/2022
2.3.2 1,020 7/18/2022
2.3.1 1,188 7/14/2022
2.3.0 1,110 7/4/2022
2.2.0 2,880 7/1/2022
2.1.5 2,049 6/13/2022
2.1.4 742 6/11/2022
2.1.3 1,295 6/6/2022
2.1.2 876 5/23/2022
2.1.1 1,081 5/18/2022
2.1.0 784 5/17/2022
2.0.3 769 5/9/2022
2.0.2 864 5/6/2022
2.0.1 769 5/5/2022
2.0.0 852 4/29/2022
2.0.0-beta7 241 4/27/2022
2.0.0-beta6 240 4/25/2022
2.0.0-beta5 1,694 4/14/2022
2.0.0-beta4 310 4/13/2022
2.0.0-beta3 271 4/13/2022
2.0.0-beta2 305 4/11/2022
2.0.0-beta1 5,649 4/7/2022
1.2.0 13,537 2/15/2022
1.1.2 811 2/11/2022
1.1.1 901 2/9/2022
1.1.0 1,883 1/13/2022
1.1.0-beta2 262 1/8/2022
1.1.0-beta1 256 1/8/2022
1.0.3 382 12/28/2021
1.0.2 7,531 10/20/2021
1.0.1 8,941 9/30/2021
1.0.0 595 9/28/2021
1.0.0-beta2 357 9/15/2021
1.0.0-beta1 318 9/13/2021
0.70.0 3,388 8/30/2021
0.69.0 959 8/18/2021
0.69.0-beta7 332 8/12/2021
0.69.0-beta6 366 8/10/2021
0.69.0-beta5 304 8/9/2021
0.69.0-beta4 333 8/6/2021
0.69.0-beta3 346 8/5/2021
0.69.0-beta2 984 7/24/2021
0.69.0-beta1 413 7/16/2021
0.68.1 1,661 4/5/2021
0.66.1 11,368 10/5/2020
0.66.0 813 9/22/2020
0.65.0 635 9/17/2020
0.64.0 1,209 9/1/2020
0.63.0 1,341 6/10/2020
0.63.0-beta3 1,433 6/4/2020
0.63.0-beta2 460 6/4/2020
0.63.0-beta1 459 6/3/2020
0.62.0 756 5/27/2020
0.61.0 668 5/14/2020
0.60.0 666 5/9/2020
0.60.0-beta3 794 5/4/2020
0.60.0-beta1 685 4/22/2020
0.50.0 3,173 4/1/2020
0.50.0-beta1 517 3/24/2020
0.40.0 807 3/19/2020
0.32.1 1,116 3/3/2020
0.32.0 1,232 2/14/2020
0.31.0 1,022 2/6/2020
0.30.0 1,834 1/23/2020
0.29.0 667 1/21/2020
0.28.1 1,053 1/8/2020
0.28.0 797 1/8/2020
0.27.2 663 1/8/2020
0.27.1 663 1/7/2020
0.27.0 686 1/6/2020
0.26.0 4,506 1/2/2020
0.25.0 1,337 11/19/2019
0.24.0 742 11/12/2019
0.23.3 754 11/4/2019
0.23.2 723 11/2/2019
0.23.1 724 10/31/2019
0.23.0 707 10/30/2019
0.22.0 700 10/30/2019
0.21.0 2,019 9/3/2019
0.20.1 739 8/28/2019
0.20.0 716 8/28/2019
0.19.1 832 8/26/2019
0.19.0 732 8/25/2019
0.18.4 882 8/19/2019
0.18.3 880 7/30/2019
0.18.2 949 7/26/2019
0.18.1 819 7/18/2019
0.18.0 807 7/17/2019
0.17.0 980 7/8/2019
0.16.2 1,293 6/1/2019
0.16.1 863 5/27/2019
0.16.0 918 5/21/2019
0.15.8 1,006 4/11/2019
0.15.7 856 4/11/2019
0.15.6 9,974 3/15/2019
0.15.5 820 3/14/2019
0.15.4 860 3/8/2019
0.15.3 869 3/6/2019
0.15.2 899 2/22/2019
0.15.1 1,153 2/14/2019
0.15.0 981 2/5/2019
0.14.4 1,001 1/29/2019
0.14.3 949 1/25/2019
0.14.2 898 1/22/2019
0.14.1 896 1/21/2019
0.14.0 967 1/14/2019
0.13.1 936 1/9/2019
0.13.0 934 1/3/2019
0.12.1 1,029 12/18/2018
0.12.0 909 12/13/2018
0.11.0 975 11/13/2018