GraphQL.Client 5.1.0

.NET Standard 2.0 .NET Framework 4.6.1
dotnet add package GraphQL.Client --version 5.1.0
NuGet\Install-Package GraphQL.Client -Version 5.1.0
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.Client" Version="5.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GraphQL.Client --version 5.1.0
#r "nuget: GraphQL.Client, 5.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install GraphQL.Client as a Cake Addin
#addin nuget:?package=GraphQL.Client&version=5.1.0

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

GraphQL.Client

A GraphQL Client for .NET Standard over HTTP.

Provides the following packages:

Package Downloads Nuget Latest
GraphQL.Client Nuget Nuget
GraphQL.Client.Abstractions Nuget Nuget
GraphQL.Client.Abstractions.Websocket Nuget Nuget
GraphQL.Client.LocalExecution Nuget Nuget
GraphQL.Client.Serializer.Newtonsoft Nuget Nuget
GraphQL.Client.Serializer.SystemTextJson Nuget Nuget
GraphQL.Primitives Nuget Nuget

Specification:

The Library will try to follow the following standards and documents:

Usage:

Create a GraphQLHttpClient

// To use NewtonsoftJsonSerializer, add a reference to NuGet package GraphQL.Client.Serializer.Newtonsoft
var graphQLClient = new GraphQLHttpClient("https://api.example.com/graphql", new NewtonsoftJsonSerializer());

Create a GraphQLRequest:

Simple Request:
var heroRequest = new GraphQLRequest {
    Query = @"
    {
        hero {
            name
        }
    }"
};
OperationName and Variables Request:
var personAndFilmsRequest = new GraphQLRequest {
    Query =@"
    query PersonAndFilms($id: ID) {
        person(id: $id) {
            name
            filmConnection {
                films {
                    title
                }
            }
        }
    }",
    OperationName = "PersonAndFilms",
    Variables = new {
        id = "cGVvcGxlOjE="
    }
};

Be careful when using byte[] in your variables object, as most JSON serializers will treat that as binary data! If you really need to send a list of bytes with a byte[] as a source, then convert it to a List<byte> first, which will tell the serializer to output a list of numbers instead of a base64-encoded string.

Execute Query/Mutation:

public class ResponseType 
{
    public PersonType Person { get; set; }
}

public class PersonType 
{
    public string Name { get; set; }
    public FilmConnectionType FilmConnection { get; set; }    
}

public class FilmConnectionType {
    public List<FilmContentType> Films { get; set; }    
}

public class FilmContentType {
    public string Title { get; set; }
}

var graphQLResponse = await graphQLClient.SendQueryAsync<ResponseType>(personAndFilmsRequest);

var personName = graphQLResponse.Data.Person.Name;

Using the extension method for anonymously typed responses (namespace GraphQL.Client.Abstractions) you could achieve the same result with the following code:

var graphQLResponse = await graphQLClient.SendQueryAsync(personAndFilmsRequest, () => new { person = new PersonType()} );
var personName = graphQLResponse.Data.person.Name;

Use Subscriptions

public class UserJoinedSubscriptionResult {
    public ChatUser UserJoined { get; set; }

    public class ChatUser {
        public string DisplayName { get; set; }
        public string Id { get; set; }
    }
}
Create subscription
var userJoinedRequest = new GraphQLRequest {
    Query = @"
    subscription {
        userJoined{
            displayName
            id
        }
    }"
};

IObservable<GraphQLResponse<UserJoinedSubscriptionResult>> subscriptionStream 
    = client.CreateSubscriptionStream<UserJoinedSubscriptionResult>(userJoinedRequest);

var subscription = subscriptionStream.Subscribe(response => 
    {
        Console.WriteLine($"user '{response.Data.UserJoined.DisplayName}' joined")
    });
End Subscription
subscription.Dispose();

Blazor WebAssembly Limitations

Blazor WebAssembly differs from other platforms as it does not support all features of other .NET runtime implementations. For instance, the following WebSocket options properties are not supported and will not be set:

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (61)

Showing the top 5 NuGet packages that depend on GraphQL.Client:

Package Downloads
GitOps.Clients.GitHub

Package Description

Queryout.SmartGateway.Sdk

Package Description

Trackmatic.Client

.Net rest client library for Trackmatic rest api

GraphQL.Client.Extensions

Extensions for GraphQL.Client to build graphQL queries from a C# model.

Speckle.Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Core is the .NET SDK for Speckle

GitHub repositories (9)

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

Repository Stars
phongnguyend/Practical.CleanArchitecture
Asp.Net Core 6 Clean Architecture (Microservices + Dapr, Modular Monolith, Monolith), Blazor, Angular 14, React 18, Vue 2.7, Domain-Driven Design, CQRS, SOLID, Asp.Net Core Identity Custom Storage, Identity Server 4 Admin UI, Entity Framework Core, Selenium, SignalR, Hosted Services, Health Checks, Cloud (Azure, AWS) Services, ...
sharpenrocks/Sharpen
Visual Studio extension that intelligently introduces new C# features into your existing codebase
FluentHub/FluentHub
A stylish yet powerful GitHub client - not active right now but check often for updates!
specklesystems/speckle-sharp
.NET SDK, Schema and Connectors: Revit, Rhino, Grasshopper, Dynamo, ETABS, AutoCAD, Civil3D & more.
VirtoCommerce/vc-storefront
Virto Commerce Storefront - ASP.NET Core 6.0
Version Downloads Last updated
5.1.0 362,705 8/1/2022
5.0.2 98,409 7/19/2022
5.0.1 10,307 7/18/2022
5.0.0 13,511 7/15/2022
4.0.2 2,045,817 12/16/2021
4.0.1 286,613 10/29/2021
4.0.0 44,817 10/27/2021
3.2.4 1,680,425 6/6/2021
3.2.3 890,031 4/2/2021
3.2.2 197,943 3/2/2021
3.2.1 357,408 1/7/2021
3.2.0 481,323 10/15/2020
3.1.9 447,054 9/17/2020
3.1.8 1,640 9/17/2020
3.1.7 3,466 9/15/2020
3.1.6 123,751 8/27/2020
3.1.5 54,777 8/24/2020
3.1.4 39,623 8/15/2020
3.1.3 344,067 6/22/2020
3.1.2 103,657 5/29/2020
3.1.1 8,749 5/26/2020
3.1.0 229,463 4/21/2020
3.0.3 11,388 4/19/2020
3.0.2 60,423 4/16/2020
3.0.1 55,312 3/26/2020
3.0.0 5,411 3/23/2020
2.1.2 102,779 3/9/2020
2.1.0 11,382 2/21/2020
2.0.0 41,584 2/7/2020
2.0.0-beta0011 368 2/7/2020
2.0.0-alpha.3 336,482 11/6/2018
2.0.0-alpha.2 48,866 9/13/2018
2.0.0-alpha.1 982 8/27/2018
1.0.3 1,926,195 5/7/2018
1.0.2 42,030 3/12/2018
1.0.1 25,415 1/27/2018
1.0.0 3,540 12/20/2017
1.0.0-beta3 833 12/17/2017
1.0.0-beta2 789 12/11/2017
1.0.0-beta1 779 12/10/2017