This is an implementation of Facebook's GraphQL in .NET.

This project uses a lexer/parser originally written by Marek Magdziak and released with a MIT license. Thank you Marek!

Programming language: C#
License: MIT License
Tags: API     JSON     Client     Query     graph     GraphQL    
Latest version: v3.2.0

GraphQL for .NET alternatives and similar packages

Based on the "API" category.
Alternatively, view GraphQL for .NET alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of GraphQL for .NET or a related project?

Add another 'API' Package


GraphQL for .NET

Join the chat at https://gitter.im/graphql-dotnet/graphql-dotnet

Test code Build artifacts Publish code CodeQL analysis codecov

Backers on Open Collective Sponsors on Open Collective

Activity Activity Activity


This is an implementation of Facebook's GraphQL in .NET.

Now the specification is being developed by the GraphQL Foundation.

This project uses a lexer/parser originally written by Marek Magdziak and released with a MIT license. Thank you Marek!

Provides the following packages:

Package Downloads NuGet Latest
GraphQL Nuget Nuget
GraphQL.SystemTextJson Nuget Nuget
GraphQL.NewtonsoftJson Nuget Nuget
GraphQL.MemoryCache Nuget Nuget
GraphQL.DataLoader Nuget Nuget
GraphQL.MicrosoftDI Nuget Nuget

You can get all preview versions from GitHub Packages. Note that GitHub requires authentication to consume the feed. See here.


  1. http://graphql-dotnet.github.io - documentation site that is built from the docs folder in the master branch.
  2. https://graphql.org/learn - learn about GraphQL, how it works, and how to use it.


All packages generated from this repository come with embedded pdb and support Source Link. If you are having difficulty understanding how the code works or have encountered an error, then it is just enough to enable Source Link in your IDE settings. Then you can debug GraphQL.NET source code as if it were part of your project.


1. GraphQL.NET engine

This is the main package, the heart of the repository in which you can find all the necessary classes for GraphQL request processing.

> dotnet add package GraphQL
2. Serialization

For serialized results, you'll need an IGraphQLSerializer implementation. We provide several serializers (or you can bring your own).

> dotnet add package GraphQL.SystemTextJson
> dotnet add package GraphQL.NewtonsoftJson

Note: You can use GraphQL.NewtonsoftJson with .NET Core 3+, just be aware it lacks async writing capabilities so writing to an ASP.NET Core 3.0 HttpResponse.Body will require you to set AllowSynchronousIO to true as per this announcement; which isn't recommended.

3. Document Caching

The recommended way to setup caching layer (for caching of parsed GraphQL documents) is to inherit from IConfigureExecution interface and register your class as its implementation. We provide in-memory implementation on top of Microsoft.Extensions.Caching.Memory package.

> dotnet add package GraphQL.MemoryCache

For more information see Document Caching.

4. DataLoader

DataLoader is a generic utility to be used as part of your application's data fetching layer to provide a simplified and consistent API over various remote data sources such as databases or web services via batching and caching.

> dotnet add package GraphQL.DataLoader

For more information see DataLoader.

Note: Prior to version 4, the contents of this package was part of the main GraphQL.NET package.

5. Subscriptions

DocumentExecuter can handle subscriptions as well as queries and mutations. For more information see Subscriptions.

6. Advanced Dependency Injection

Also we provide some extra classes for advanced dependency injection usage on top of Microsoft.Extensions.DependencyInjection.Abstractions package.

> dotnet add package GraphQL.MicrosoftDI

For more information see Thread safety with scoped services.



You can also try an example of GraphQL demo server inside this repo - [GraphQL.Harness](src/GraphQL.Harness/GraphQL.Harness.csproj). It supports the popular IDEs for managing GraphQL requests and exploring GraphQL schema:


Upgrade Guides

You can see the changes in public APIs using fuget.org.

Basic Usage

Define your schema with a top level query object then execute that query.

Fully-featured examples can be found here.

Hello World

using System;
using System.Threading.Tasks;
using GraphQL;
using GraphQL.Types;
using GraphQL.SystemTextJson; // First add PackageReference to GraphQL.SystemTextJson

var schema = Schema.For(@"
  type Query {
    hello: String

var root = new { Hello = "Hello World!" };
var json = await schema.ExecuteAsync(_ =>
  _.Query = "{ hello }";
  _.Root = root;


Schema First Approach

This example uses the GraphQL schema language. See the documentation for more examples and information.

public class Droid
  public string Id { get; set; }
  public string Name { get; set; }

public class Query
  public Droid GetDroid()
    return new Droid { Id = "123", Name = "R2-D2" };

var schema = Schema.For(@"
  type Droid {
    id: ID
    name: String

  type Query {
    droid: Droid
", _ => {

var json = await schema.ExecuteAsync(_ =>
  _.Query = "{ droid { id name } }";


public class Droid
  public string Id { get; set; }
  public string Name { get; set; }

public class Query
  private List<Droid> _droids = new List<Droid>
    new Droid { Id = "123", Name = "R2-D2" }

  public Droid GetDroid(string id)
    return _droids.FirstOrDefault(x => x.Id == id);

var schema = Schema.For(@"
  type Droid {
    id: ID
    name: String

  type Query {
    droid(id: ID): Droid
", _ => {

var json = await schema.ExecuteAsync(_ =>
  _.Query = $"{{ droid(id: \"123\") {{ id name }} }}";


Grammar / AST

Operation Execution

  • [x] Scalars
  • [x] Objects
  • [x] Lists of objects/interfaces
  • [x] Interfaces
  • [x] Unions
  • [x] Arguments
  • [x] Variables
  • [x] Fragments
  • [x] Directives
    • [x] Include
    • [x] Skip
    • [x] Custom
  • [x] Enumerations
  • [x] Input Objects
  • [x] Mutations
  • [x] Subscriptions
  • [x] Async execution


  • [x] Arguments of correct type
  • [x] Default values of correct type
  • [x] Fields on correct type
  • [x] Fragments on composite types
  • [x] Known argument names
  • [x] Known directives
  • [x] Known fragment names
  • [x] Known type names
  • [x] Lone anonymous operations
  • [x] No fragment cycles
  • [x] No undefined variables
  • [x] No unused fragments
  • [x] No unused variables
  • [x] Overlapping fields can be merged
  • [x] Possible fragment spreads
  • [x] Provide non-null arguments
  • [x] Scalar leafs
  • [x] Unique argument names
  • [x] Unique directives per location
  • [x] Unique fragment names
  • [x] Unique input field names
  • [x] Unique operation names
  • [x] Unique variable names
  • [x] Variables are input types
  • [x] Variables in allowed position
  • [x] Single root field

Schema Introspection

GraphQL.NET supports introspection schema from October 2021 spec with some additional experimental introspection extensions.

Publishing NuGet packages

The package publishing process is automated with GitHub Actions.

After your PR is merged into master or develop, preview packages are published to GitHub Packages.

Stable versions of packages are published to NuGet when a release is created.


This project exists thanks to all the people who contribute.

PRs are welcome! Looking for something to work on? The list of open issues is a great place to start. You can help the project simply respond to some of the asked questions.

The default branch is master. It is designed for non-breaking changes, that is to publish versions 7.x.x. If you have a PR with some breaking changes, then please target it to the develop branch that tracks changes for v8.0.0.


Thank you to all our backers! 🙏 Become a backer.


Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.

*Note that all licence references and agreements mentioned in the GraphQL for .NET README section above are relevant to that project's source code only.