GraphQL.Client.Abstractions 6.1.0

dotnet add package GraphQL.Client.Abstractions --version 6.1.0                
NuGet\Install-Package GraphQL.Client.Abstractions -Version 6.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.Abstractions" Version="6.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 6.1.0                
#r "nuget: GraphQL.Client.Abstractions, 6.1.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.Abstractions as a Cake Addin
#addin nuget:?package=GraphQL.Client.Abstractions&version=6.1.0

// Install GraphQL.Client.Abstractions as a Cake Tool
#tool nuget:?package=GraphQL.Client.Abstractions&version=6.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

The intended use of GraphQLHttpClient is to keep one instance alive per endpoint (obvious in case you're operating full websocket, but also true for regular requests) and is built with thread-safety in mind.

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

[!NOTE] GraphQLHttpClient is meant to be used as a single long-lived instance per endpoint (i.e. register as singleton in a DI system), which should be reused for multiple requests.

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

[!WARNING] 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;

[!IMPORTANT] Note that the field in the GraphQL response which gets deserialized into the response object is the data field.

A common mistake is to try to directly use the PersonType class as response type (because thats the thing you actually want to query), but the returned response object contains a property person containing a PersonType object (like the ResponseType modelled above).

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

Automatic persisted queries (APQ)

Automatic persisted queries (APQ) are supported since client version 6.1.0.

APQ can be enabled by configuring GraphQLHttpClientOptions.EnableAutomaticPersistedQueries to resolve to true.

By default, the client will automatically disable APQ for the current session if the server responds with a PersistedQueryNotSupported error or a 400 or 600 HTTP status code. This can be customized by configuring GraphQLHttpClientOptions.DisableAPQ.

To re-enable APQ after it has been automatically disabled, GraphQLHttpClient needs to be disposed an recreated.

APQ works by first sending a hash of the query string to the server, and only sending the full query string if the server has not yet cached a query with a matching hash. With queries supplied as a string parameter to GraphQLRequest, the hash gets computed each time the request is sent.

When you want to reuse a query string (propably to leverage APQ 😉), declare the query using the GraphQLQuery class. This way, the hash gets computed once on construction of the GraphQLQuery object and handed down to each GraphQLRequest using the query.

GraphQLQuery query = new("""
                         query PersonAndFilms($id: ID) {
                             person(id: $id) {
                                 name
                                 filmConnection {
                                     films {
                                         title
                                     }
                                 }
                             }
                         }
                         """);
                         
var graphQLResponse = await graphQLClient.SendQueryAsync<ResponseType>(
    query, 
    "PersonAndFilms",
    new { id = "cGVvcGxlOjE=" });

Syntax Highlighting for GraphQL strings in IDEs

.NET 7.0 introduced the StringSyntaxAttribute to have a unified way of telling what data is expected in a given string or ReadOnlySpan<char>. IDEs like Visual Studio and Rider can then use this to provide syntax highlighting and checking.

From v6.0.4 on all GraphQL string parameters in this library are decorated with the [StringSyntax("GraphQL")] attribute.

Currently, there is no native support for GraphQL formatting and syntax highlighting in Visual Studio, but the GraphQLTools Extension provides that for you.

For Rider, JetBrains provides a Plugin, too.

To leverage syntax highlighting in variable declarations, use the GraphQLQuery class.

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 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 is compatible.  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 is compatible.  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 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 (8)

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

SauceLabs.Visual

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

Challengermode.Api.Client

Challengermode client to access the GraphQL api in a smooth way.

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
6.1.0 218,097 5/21/2024
6.0.5 154,596 4/22/2024
6.0.4 1,480 4/22/2024
6.0.3 204,834 3/20/2024
6.0.2 1,032,717 11/23/2023
6.0.1 475,485 9/29/2023
6.0.0 1,849,169 4/13/2023
5.1.1 1,559,593 1/23/2023
5.1.0 2,703,422 8/1/2022
5.0.2 683,471 7/19/2022
5.0.1 37,337 7/18/2022
5.0.0 44,127 7/15/2022
4.0.2 4,912,098 12/16/2021
4.0.1 597,443 10/29/2021
4.0.0 153,800 10/27/2021
3.2.4 2,887,840 6/6/2021
3.2.3 1,570,955 4/2/2021
3.2.2 329,877 3/2/2021
3.2.1 595,210 1/7/2021
3.2.0 787,688 10/15/2020
3.1.9 653,413 9/17/2020
3.1.8 3,817 9/17/2020
3.1.7 6,834 9/15/2020
3.1.6 182,849 8/27/2020
3.1.5 98,002 8/24/2020
3.1.4 68,705 8/15/2020
3.1.3 524,619 6/22/2020
3.1.2 222,086 5/29/2020
3.1.1 29,465 5/26/2020
3.1.0 315,142 4/21/2020
3.0.3 17,314 4/19/2020
3.0.2 155,838 4/16/2020
3.0.1 85,245 3/26/2020
3.0.0 8,308 3/23/2020
2.1.2 133,688 3/9/2020
2.1.0 21,929 2/21/2020
2.0.0 51,500 2/7/2020
2.0.0-beta0011 624 2/7/2020