How to set up EntityGraphQL with ASP.NET Core?

Install the EntityGraphQL.AspNet package, add services with AddGraphQLSchema, and use MapGraphQL in your app builder to set up a POST endpoint at /graphql, as detailed in the quick start guide.

EntityGraphQL vs Hot Chocolate: which is better for .NET?

EntityGraphQL excels at efficient LINQ-based queries on existing .NET models, while Hot Chocolate offers more features like subscriptions. Choose based on performance needs versus advanced GraphQL capabilities.

Does EntityGraphQL support real-time subscriptions?

No, EntityGraphQL primarily focuses on queries and mutations without built-in subscription support. For real-time updates, you may need custom implementations or consider other libraries.

How to use EntityGraphQL with non-Entity Framework data sources?

It works with any .NET object via IQueryable or IEnumerable. Use SchemaBuilder to create a schema from plain objects, then compile queries to LINQ expressions, as shown in the EQL examples.

How to implement authorization in EntityGraphQL schemas?

Authorization can be applied at the ASP.NET route level or within the schema using attributes or custom middleware, with documentation covering claims-based security for specific parts of the schema.

What are the performance benefits over REST APIs?

EntityGraphQL reduces over-fetching by selecting only requested fields through LINQ projections, leading to optimized database queries and smaller payloads for complex data graphs.

Open-Awesome

EntityGraphQL

MITC#5.7.2

A .NET GraphQL library that builds schemas from .NET objects with efficient LINQ-based query execution.

Visit Website GitHub

454 stars63 forks0 contributors

What is EntityGraphQL?

EntityGraphQL is a GraphQL library for .NET that enables developers to build GraphQL APIs by mapping GraphQL schemas directly to .NET objects. It solves the problem of inefficient data retrieval by compiling GraphQL queries into LINQ expressions, ensuring only requested fields are fetched, and works seamlessly with Entity Framework or any .NET object model.

Target Audience

.NET developers building GraphQL APIs, especially those using Entity Framework or other ORMs, and teams needing efficient query execution with support for multiple data sources.

Value Proposition

Developers choose EntityGraphQL for its deep integration with .NET ecosystems, performance optimizations via LINQ projection, and flexibility to work with any data source, making it a robust alternative to other GraphQL implementations for .NET.

Overview

A GraphQL library for .NET

Use Cases

Best For

Building GraphQL APIs on top of existing Entity Framework models
Optimizing database queries by selecting only required fields in GraphQL requests
Integrating multiple data sources into a single GraphQL schema
Creating dynamic filtering or calculated fields using the EQL expression language
Developing ASP.NET applications with minimal GraphQL setup overhead
Extending .NET applications with GraphQL without rewriting data access layers

Not Ideal For

Projects requiring real-time GraphQL subscriptions, as EntityGraphQL's focus is on queries and mutations without built-in subscription support.
Teams using non-.NET technology stacks, since the library is tightly integrated with .NET and LINQ ecosystems.
Developers preferring schema-first GraphQL design, as EntityGraphQL is inherently object-first based on .NET class mappings.

Pros & Cons

Pros

Efficient Query Execution

Compiles GraphQL queries to LINQ expressions that select only requested fields, reducing database load and data transfer, as shown in the Entity Framework examples.

Seamless .NET Integration

Automatically maps GraphQL schemas to .NET objects like Entity Framework DbContext, enabling quick setup without rewriting existing data layers.

Multi-Source Flexibility

Extensible architecture allows combining multiple data sources into a single GraphQL schema, supporting unified APIs from disparate systems.

ASP.NET Optimization

Provides EntityGraphQL.AspNet package with easy route mapping and authorization integration, simplifying ASP.NET Core deployments as per the quick start.

Cons

Missing Advanced Features

Lacks built-in support for GraphQL subscriptions or federation, limiting real-time capabilities compared to alternatives like Hot Chocolate.

.NET Ecosystem Lock-in

Heavily reliant on .NET and LINQ, making it unsuitable for cross-platform projects or those using non-relational databases without .NET support.

Custom Expression Complexity

EQL (Entity Query Language) introduces a non-standard syntax for filtering and calculations, adding learning curve and potential maintenance overhead.

Frequently Asked Questions

Related Projects

GraphQL.NET

GraphQL for .NET

Stars5,983

Forks942

Last commit18 hours ago

HotChocolate

Welcome to the home of the Hot Chocolate GraphQL server for .NET, the Strawberry Shake GraphQL client for .NET and Nitro the awesome Monaco based GraphQL IDE.

Stars5,701

Forks803

Last commit22 hours ago

graphql-net

Convert GraphQL to IQueryable

Stars886

Forks82

Last commit3 years ago

ZeroQL

C# GraphQL client with Linq-like syntax

Stars320

Forks19

Last commit4 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub