GraphQL 7.7.1

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

// Install GraphQL as a Cake Tool
#tool nuget:?package=GraphQL&version=7.7.1

GraphQL for .NET

License codecov Nuget Nuget GitHub Release Date GitHub commits since latest release (by date) Size

GitHub contributors Activity Activity Activity

❤️ Become a backer! ❤️ Backers on Open Collective Sponsors on Open Collective
💲 Get paid for contributing! 💲 GitHub issues by-label GitHub closed issues by-label

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.

Documentation

  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.

Debugging

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.

Installation

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.

Examples

https://github.com/graphql-dotnet/examples

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

Ahead-of-time compilation

GraphQL.NET supports ahead-of-time (AOT) compilation for execution of code-first schemas with .NET 7. This allows for use within iOS and Android apps, as well as other environments where such features as JIT compilation or dynamic code generation are not available. It may be necessary to explicitly instruct the AOT compiler to include the .NET types necessary for your schema to operate correctly. Of particular note, your query, mutation and subscription types' constructors may be trimmed; register them in your DI engine to prevent this. Also, Field(x => x.MyField) for enumeration values will require manually adding a mapping reference via RegisterTypeMapping<MyEnum, EnumerationGraphType<MyEnum>>(). Please see the GraphQL.AotCompilationSample for a simple demonstration of AOT compilation. Schema-first and type-first schemas have additional limtations and configuration requirements. AOT compilation has not been tested with frameworks other than .NET 7 on Windows and Linux (e.g. Xamarin).

Training

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;
});

Console.WriteLine(json);

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
{
  [GraphQLMetadata("droid")]
  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
  }
", _ => {
    _.Types.Include<Query>();
});

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

Parameters

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" }
  };

  [GraphQLMetadata("droid")]
  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
  }
", _ => {
    _.Types.Include<Query>();
});

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

Roadmap

Grammar / AST

Operation Execution

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

Validation

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

Contributors

This project exists thanks to all the people who contribute. <a href="https://github.com/graphql-dotnet/graphql-dotnet/graphs/contributors"><img src="https://opencollective.com/graphql-net/contributors.svg?width=890&button=false" /></a>

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.

Backers

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

Contributions are very much appreciated and are used to support the project primarily via bounties paid directly to contributors to the project. Please help us to express gratitude to those individuals who devote time and energy to contributing to this project by supporting their efforts in a tangible means. A list of the outstanding issues to which we are sponsoring via bounties can be found here.

<a href="https://opencollective.com/graphql-net#backers" target="_blank"><img src="https://opencollective.com/graphql-net/backers.svg?width=890"></a>

Sponsors

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

<a href="https://opencollective.com/graphql-net/sponsor/0/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/1/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/1/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/2/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/2/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/3/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/3/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/4/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/4/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/5/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/5/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/6/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/6/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/7/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/7/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/8/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/8/avatar.svg"></a> <a href="https://opencollective.com/graphql-net/sponsor/9/website" target="_blank"><img src="https://opencollective.com/graphql-net/sponsor/9/avatar.svg"></a>

Product 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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  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 (150)

Showing the top 5 NuGet packages that depend on GraphQL:

Package Downloads
WireMock.Net The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Lightweight Http Mocking Server for .Net, inspired by WireMock from the Java landscape.

GraphQL.NewtonsoftJson

JSON.NET serializer for GraphQL.NET

GraphQL.SystemTextJson

System.Text.Json serializer for GraphQL.NET

GraphQL.DataLoader

GraphQL DataLoader implementation

GraphQL.Server.Transports.Subscriptions.Abstractions

Package Description

GitHub repositories (28)

Showing the top 5 popular GitHub repositories that depend on GraphQL:

Repository Stars
ThreeMammals/Ocelot
.NET API Gateway
OrchardCMS/OrchardCore
Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.
borisdj/EFCore.BulkExtensions
Entity Framework EF Core efcore Bulk Batch Extensions with BulkCopy in .Net for Insert Update Delete Read (CRUD), Truncate and SaveChanges operations on SQL Server, PostgreSQL, MySQL, SQLite
Squidex/squidex
Headless CMS and Content Managment Hub
WireMock-Net/WireMock.Net
WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.
Version Downloads Last updated
7.8.0 111,734 2/6/2024
7.7.2 96,398 12/16/2023
7.7.1 8,161 12/13/2023
7.7.0 1,263 12/13/2023
7.6.1 264,380 8/11/2023
7.6.0 115,348 7/31/2023
7.5.0 2,601,196 6/17/2023
7.4.1 184,007 4/21/2023
7.4.0 93,006 4/14/2023
7.3.1 205,110 4/2/2023
7.3.0 203,099 2/27/2023
7.2.2 244,576 1/2/2023
7.2.1 80,464 12/8/2022
7.2.0 71,464 12/3/2022
7.1.1 399,590 9/19/2022
7.1.0 6,231 9/16/2022
7.0.2 257,642 8/23/2022
7.0.1 28,762 8/17/2022
7.0.0 102,926 8/16/2022
5.4.0 210,452 11/30/2022
5.3.3 626,890 7/19/2022
5.3.2 220,855 7/3/2022
5.3.1 20,349 6/26/2022
5.3.0 1,369,672 5/14/2022
5.2.0 225,999 5/6/2022
5.1.1 408,304 4/11/2022
5.1.0 6,265 4/8/2022
5.0.0 51,457 3/30/2022
4.8.0 1,269,843 3/30/2022
4.7.1 1,047,739 1/1/2022
4.7.0 100,569 12/27/2021
4.6.1 1,121,146 9/29/2021
4.6.0 635,533 8/18/2021
4.5.0 882,472 4/29/2021
4.4.0 34,569 4/22/2021
4.3.0 224,918 4/16/2021
4.2.0 433,963 3/30/2021
4.1.0 616,598 3/26/2021
4.0.2 130,664 3/19/2021
4.0.1 4,457 3/17/2021
4.0.0 3,570 3/17/2021
3.3.2 1,097,420 1/24/2021
3.3.1 87,357 1/14/2021
3.3.0 5,735 1/14/2021
3.2.0 827,708 12/7/2020
3.1.6 410,937 12/1/2020
3.1.5 64,054 11/20/2020
3.1.4 42,309 11/15/2020
3.1.3 660,125 10/30/2020
3.1.2 79,199 10/28/2020
3.1.1 4,258 10/27/2020
3.1.0 55,146 10/23/2020
3.0.0.2026 764,848 9/17/2020
3.0.0 321,222 9/2/2020
3.0.0-preview-1719 18,508 8/17/2020
3.0.0-preview-1648 103,045 5/5/2020
3.0.0-preview-1490 218,044 2/19/2020
3.0.0-preview-1354 1,658 2/19/2020
3.0.0-preview-1352 188,766 11/23/2019
3.0.0-preview-1271 35,496 10/4/2019
3.0.0-preview-1268 127,534 9/17/2019
3.0.0-preview-1264 1,128 9/16/2019
3.0.0-preview-1211 7,086 8/16/2019
3.0.0-preview-1194 12,913 8/2/2019
3.0.0-preview-1175 17,888 6/4/2019
3.0.0-preview-1141 8,880 3/18/2019
3.0.0-preview-1107 3,427 3/2/2019
2.4.0 6,331,012 11/15/2018
2.3.0 1,211,038 10/17/2018
2.2.0 8,000 10/17/2018
2.1.0 91,128 9/30/2018
2.0.0 461,675 8/11/2018
2.0.0-preview-997 2,646 8/10/2018
2.0.0-preview-1002 2,383 8/11/2018
2.0.0-alpha-978 11,369 8/1/2018
2.0.0-alpha-952 9,302 7/25/2018
2.0.0-alpha-951 4,979 7/24/2018
2.0.0-alpha-947 5,355 7/19/2018
2.0.0-alpha-938 23,057 7/1/2018
2.0.0-alpha-937 2,421 6/29/2018
2.0.0-alpha-931 3,630 6/25/2018
2.0.0-alpha-927 4,218 6/18/2018
2.0.0-alpha-923 6,482 6/13/2018
2.0.0-alpha-912 11,132 5/16/2018
2.0.0-alpha-899 5,579 5/2/2018
2.0.0-alpha-887 8,524 4/20/2018
2.0.0-alpha-870 21,642 3/27/2018
2.0.0-alpha-868 17,323 3/15/2018
2.0.0-alpha-863 4,330 3/3/2018
2.0.0-alpha-859 2,808 2/25/2018
2.0.0-alpha-851 3,998 2/12/2018
2.0.0-alpha-839 12,183 1/23/2018
2.0.0-alpha-820 15,991 12/15/2017
2.0.0-alpha-817 3,636 12/2/2017
2.0.0-alpha-811 3,145 11/18/2017
2.0.0-alpha-805 3,796 11/3/2017
2.0.0-alpha-802 19,170 9/27/2017
2.0.0-alpha-797 2,112 9/23/2017
2.0.0-alpha-793 2,062 9/22/2017
2.0.0-alpha-783 5,416 9/16/2017
0.17.3 189,243 9/5/2017
0.17.2 28,388 8/2/2017
0.17.1 12,407 7/13/2017
0.17.0 2,821 7/10/2017
0.16.1 2,956 7/7/2017
0.16.0 2,620 7/6/2017
0.16.0-alpha-697 2,747 4/29/2017
0.15.1.678 63,080 3/2/2017
0.15.0.671 2,990 2/25/2017
0.14.7.667 2,492 2/24/2017
0.14.6.657 22,473 1/26/2017
0.14.5.654 3,393 1/19/2017
0.14.4.649 3,096 1/13/2017
0.14.3.646 2,586 1/13/2017
0.14.1.638 3,140 12/23/2016
0.14.0.633 32,934 11/30/2016
0.13.1.601 6,173 11/16/2016
0.13.0.562 3,652 10/14/2016
0.12.3.556 2,873 10/7/2016
0.12.2-alpha-550 2,231 10/7/2016
0.12.1-alpha-545 2,232 10/6/2016
0.12.0-alpha-538 3,010 9/16/2016
0.12.0-alpha-536 2,903 9/16/2016
0.12.0-alpha-511 2,293 8/29/2016
0.11.0.493 3,918 8/27/2016
0.10.3.478 2,548 8/27/2016
0.10.2.436 2,898 8/20/2016
0.10.1.349 3,979 7/30/2016
0.10.0.325 2,681 7/22/2016
0.10.0.323 2,580 7/22/2016
0.9.3 2,683 6/23/2016
0.9.2 2,765 6/18/2016
0.9.1 2,920 6/13/2016
0.9.0 2,773 6/10/2016
0.8.2 2,695 6/10/2016
0.8.1 17,928 6/8/2016
0.8.0 8,670 6/7/2016
0.8.0-alpha 2,187 6/3/2016
0.7.1 6,867 6/4/2016
0.7.0 2,407 6/3/2016
0.6.6 2,524 5/12/2016
0.6.5 3,061 4/22/2016
0.6.4 2,465 4/19/2016
0.6.3 10,167 4/6/2016
0.6.2 2,511 3/23/2016
0.6.1 2,784 3/22/2016
0.6.0 2,650 3/22/2016
0.5.1 2,927 3/4/2016
0.5.0 2,462 3/2/2016
0.4.1 2,645 12/22/2015
0.4.0 6,026 12/12/2015
0.3.0 2,800 8/26/2015
0.2.0 4,405 7/16/2015
0.1.1 2,935 7/12/2015
0.1.0 6,513 7/8/2015