EntityGraphQL 4.0.0-beta2

This is a prerelease version of EntityGraphQL.
There is a newer version of this package available.
See the version list below for details.
dotnet add package EntityGraphQL --version 4.0.0-beta2
NuGet\Install-Package EntityGraphQL -Version 4.0.0-beta2
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="4.0.0-beta2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EntityGraphQL --version 4.0.0-beta2
#r "nuget: EntityGraphQL, 4.0.0-beta2"
#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=4.0.0-beta2&prerelease

// Install EntityGraphQL as a Cake Tool
#tool nuget:?package=EntityGraphQL&version=4.0.0-beta2&prerelease

Entity GraphQL

A GraphQL library for .NET Core

Build Nuget

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

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.

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 was computed.  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.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)
Included target framework(s) (in package)
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.2.0 203 3/19/2024
5.2.0-beta2 409 2/11/2024
5.2.0-beta1 1,527 11/16/2023
5.1.1 2,858 1/24/2024
5.1.0 3,184 11/16/2023
5.0.1 3,742 9/28/2023
5.0.0 2,950 8/2/2023
5.0.0-beta1 803 6/17/2023
4.3.1 414 11/22/2023
4.3.0 6,598 3/14/2023
4.2.1 13,200 12/22/2022
4.2.0 5,808 11/16/2022
4.1.2 1,963 10/20/2022
4.1.1 1,309 10/18/2022
4.1.0 1,267 10/13/2022
4.0.1 1,665 10/5/2022
4.0.0 2,314 9/10/2022
4.0.0-beta2 1,129 9/8/2022
4.0.0-beta1 726 9/6/2022
3.0.5 1,584 8/16/2022
3.0.4 1,242 8/5/2022
3.0.3 1,702 8/4/2022
3.0.2 1,406 8/1/2022
3.0.1 1,141 8/1/2022
3.0.0 1,275 7/31/2022
2.3.2 1,431 7/18/2022
2.3.1 1,590 7/14/2022
2.3.0 1,492 7/4/2022
2.2.0 3,294 7/1/2022
2.1.5 2,760 6/13/2022
2.1.4 1,136 6/11/2022
2.1.3 1,707 6/6/2022
2.1.2 1,292 5/23/2022
2.1.1 1,497 5/18/2022
2.1.0 1,167 5/17/2022
2.0.3 1,180 5/9/2022
2.0.2 1,274 5/6/2022
2.0.1 1,177 5/5/2022
2.0.0 1,259 4/29/2022
2.0.0-beta7 630 4/27/2022
2.0.0-beta6 626 4/25/2022
2.0.0-beta5 2,080 4/14/2022
2.0.0-beta4 736 4/13/2022
2.0.0-beta3 701 4/13/2022
2.0.0-beta2 736 4/11/2022
2.0.0-beta1 6,051 4/7/2022
1.2.0 15,326 2/15/2022
1.1.2 1,214 2/11/2022
1.1.1 1,293 2/9/2022
1.1.0 2,477 1/13/2022
1.1.0-beta2 674 1/8/2022
1.1.0-beta1 653 1/8/2022
1.0.3 780 12/28/2021
1.0.2 7,992 10/20/2021
1.0.1 12,566 9/30/2021
1.0.0 979 9/28/2021
1.0.0-beta2 750 9/15/2021
1.0.0-beta1 702 9/13/2021
0.70.0 3,793 8/30/2021
0.69.0 1,338 8/18/2021
0.69.0-beta7 711 8/12/2021
0.69.0-beta6 755 8/10/2021
0.69.0-beta5 713 8/9/2021
0.69.0-beta4 746 8/6/2021
0.69.0-beta3 741 8/5/2021
0.69.0-beta2 1,361 7/24/2021
0.69.0-beta1 806 7/16/2021
0.68.1 2,149 4/5/2021
0.66.1 13,020 10/5/2020
0.66.0 1,247 9/22/2020
0.65.0 1,075 9/17/2020
0.64.0 1,639 9/1/2020
0.63.0 1,762 6/10/2020
0.63.0-beta3 1,854 6/4/2020
0.63.0-beta2 880 6/4/2020
0.63.0-beta1 888 6/3/2020
0.62.0 1,170 5/27/2020
0.61.0 1,070 5/14/2020
0.60.0 1,085 5/9/2020
0.60.0-beta3 1,226 5/4/2020
0.60.0-beta1 1,119 4/22/2020
0.50.0 3,773 4/1/2020
0.50.0-beta1 952 3/24/2020
0.40.0 1,250 3/19/2020
0.32.1 1,580 3/3/2020
0.32.0 1,662 2/14/2020
0.31.0 1,439 2/6/2020
0.30.0 2,267 1/23/2020
0.29.0 1,102 1/21/2020
0.28.1 1,489 1/8/2020
0.28.0 1,238 1/8/2020
0.27.2 1,091 1/8/2020
0.27.1 1,110 1/7/2020
0.27.0 1,124 1/6/2020
0.26.0 4,947 1/2/2020
0.25.0 1,772 11/19/2019
0.24.0 1,151 11/12/2019
0.23.3 1,181 11/4/2019
0.23.2 1,160 11/2/2019
0.23.1 1,152 10/31/2019
0.23.0 1,126 10/30/2019
0.22.0 1,133 10/30/2019
0.21.0 2,439 9/3/2019
0.20.1 1,175 8/28/2019
0.20.0 1,126 8/28/2019
0.19.1 1,245 8/26/2019
0.19.0 1,155 8/25/2019
0.18.4 1,295 8/19/2019
0.18.3 1,315 7/30/2019
0.18.2 1,399 7/26/2019
0.18.1 1,251 7/18/2019
0.18.0 1,256 7/17/2019
0.17.0 1,405 7/8/2019
0.16.2 1,722 6/1/2019
0.16.1 1,302 5/27/2019
0.16.0 1,362 5/21/2019
0.15.8 1,447 4/11/2019
0.15.7 1,273 4/11/2019
0.15.6 10,406 3/15/2019
0.15.5 1,239 3/14/2019
0.15.4 1,282 3/8/2019
0.15.3 1,273 3/6/2019
0.15.2 1,297 2/22/2019
0.15.1 1,573 2/14/2019
0.15.0 1,402 2/5/2019
0.14.4 1,438 1/29/2019
0.14.3 1,386 1/25/2019
0.14.2 1,331 1/22/2019
0.14.1 1,344 1/21/2019
0.14.0 1,413 1/14/2019
0.13.1 1,387 1/9/2019
0.13.0 1,362 1/3/2019
0.12.1 1,463 12/18/2018
0.12.0 1,334 12/13/2018
0.11.0 1,408 11/13/2018