GraphQL.Client 6.0.0

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

// Install GraphQL.Client as a Cake Tool
#tool nuget:?package=GraphQL.Client&version=6.0.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 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 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 was computed. 
.NET Framework net461 is compatible.  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 (101)

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

Package Downloads
GraphQL.Client.Extensions

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

Speckle.Core

Core is the .NET SDK for Speckle

Queryout.SmartGateway.Sdk

Package Description

Trackmatic.Client

.Net rest client library for Trackmatic rest api

SauceLabs.Visual

Sauce Labs Visual's integration allows customers to run Visual Testing while running their Selenium sessions.

GitHub repositories (15)

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

Repository Stars
Squidex/squidex
Headless CMS and Content Managment Hub
phongnguyend/Practical.CleanArchitecture
Full-stack .Net 8 Clean Architecture (Microservices, Modular Monolith, Monolith), Blazor, Angular 18, React 18, Vue 3, BFF with YARP, Domain-Driven Design, CQRS, SOLID, Asp.Net Core Identity Custom Storage, OpenID Connect, Entity Framework Core, OpenTelemetry, SignalR, Hosted Services, Health Checks, Rate Limiting, Cloud Services (Azure, AWS, GCP).
0x5bfa/FluentHub
A stylish yet powerful GitHub client for Windows
getsentry/sentry-dotnet
Sentry SDK for .NET
sharpenrocks/Sharpen
Visual Studio extension that intelligently introduces new C# features into your existing codebase
Version Downloads Last updated
6.1.0 1,510,072 5/21/2024
6.0.5 251,447 4/22/2024
6.0.4 7,255 4/22/2024
6.0.3 322,348 3/20/2024
6.0.2 1,499,701 11/23/2023
6.0.1 567,797 9/29/2023
6.0.0 2,160,517 4/13/2023
5.1.1 1,786,474 1/23/2023
5.1.0 2,760,632 8/1/2022
5.0.2 904,636 7/19/2022
5.0.1 24,288 7/18/2022
5.0.0 39,359 7/15/2022
4.0.2 5,155,984 12/16/2021
4.0.1 529,459 10/29/2021
4.0.0 180,482 10/27/2021
3.2.4 3,039,748 6/6/2021
3.2.3 1,666,277 4/2/2021
3.2.2 301,059 3/2/2021
3.2.1 580,151 1/7/2021
3.2.0 793,965 10/15/2020
3.1.9 664,527 9/17/2020
3.1.8 2,544 9/17/2020
3.1.7 4,007 9/15/2020
3.1.6 161,630 8/27/2020
3.1.5 92,001 8/24/2020
3.1.4 63,838 8/15/2020
3.1.3 523,898 6/22/2020
3.1.2 241,344 5/29/2020
3.1.1 16,495 5/26/2020
3.1.0 331,903 4/21/2020
3.0.3 17,160 4/19/2020
3.0.2 61,589 4/16/2020
3.0.1 76,884 3/26/2020
3.0.0 7,543 3/23/2020
2.1.2 134,146 3/9/2020
2.1.0 16,385 2/21/2020
2.0.0 53,919 2/7/2020
2.0.0-beta0011 599 2/7/2020
2.0.0-alpha.3 433,742 11/6/2018
2.0.0-alpha.2 84,961 9/13/2018
2.0.0-alpha.1 1,237 8/27/2018
1.0.3 3,143,860 5/7/2018
1.0.2 94,972 3/12/2018
1.0.1 30,785 1/27/2018
1.0.0 20,419 12/20/2017
1.0.0-beta3 1,088 12/17/2017
1.0.0-beta2 1,090 12/11/2017
1.0.0-beta1 1,049 12/10/2017