GraphQL.Client.Abstractions 5.1.0

.NET Standard 2.0
Install-Package GraphQL.Client.Abstractions -Version 5.1.0
dotnet add package GraphQL.Client.Abstractions --version 5.1.0
<PackageReference Include="GraphQL.Client.Abstractions" 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.Abstractions --version 5.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: GraphQL.Client.Abstractions, 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.Abstractions as a Cake Addin
#addin nuget:?package=GraphQL.Client.Abstractions&version=5.1.0

// Install GraphQL.Client.Abstractions as a Cake Tool
#tool nuget:?package=GraphQL.Client.Abstractions&version=5.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

Useful Links:

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
.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 (5)

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

Package Downloads
GraphQL.Client

A GraphQL Client for .NET Standard

GraphQL.Client.Abstractions.Websocket

Abstractions for the Websocket transport used in GraphQL.Client

GraphQL.Client.LocalExecution

A GraphQL Client which executes the queries directly on a provided GraphQL schema using graphql-dotnet

MusixmatchClientLib

C# library to interact with Musixmatch Private APIs.

KornSW.AwsConvenience.GraphQL

some convenience for using AWS from .NET

GitHub repositories (1)

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

Repository Stars
SaviorXTanren/mixer-mixitup
Streaming bot application for handling chat, events, moderation, and other streamer assistance features
Version Downloads Last updated
5.1.0 15,705 8/1/2022
5.0.2 17,905 7/19/2022
5.0.1 8,053 7/18/2022
5.0.0 7,869 7/15/2022
4.0.2 1,263,448 12/16/2021
4.0.1 278,776 10/29/2021
4.0.0 39,719 10/27/2021
3.2.4 1,303,004 6/6/2021
3.2.3 744,572 4/2/2021
3.2.2 189,401 3/2/2021
3.2.1 348,547 1/7/2021
3.2.0 450,341 10/15/2020
3.1.9 403,612 9/17/2020
3.1.8 1,779 9/17/2020
3.1.7 5,159 9/15/2020
3.1.6 127,242 8/27/2020
3.1.5 50,410 8/24/2020
3.1.4 40,321 8/15/2020
3.1.3 328,225 6/22/2020
3.1.2 87,340 5/29/2020
3.1.1 18,545 5/26/2020
3.1.0 204,332 4/21/2020
3.0.3 11,353 4/19/2020
3.0.2 84,094 4/16/2020
3.0.1 57,186 3/26/2020
3.0.0 5,231 3/23/2020
2.1.2 101,279 3/9/2020
2.1.0 12,998 2/21/2020
2.0.0 37,852 2/7/2020
2.0.0-beta0011 371 2/7/2020