A serializer implementation for GraphQL.Client using System.Text.Json as underlying JSON library
$ dotnet add package GraphQL.Client.Serializer.SystemTextJsonA GraphQL Client for .NET Standard over HTTP.
Provides the following packages:
| Package | Downloads | Nuget Latest |
|---|---|---|
| GraphQL.Client |  |  |
| GraphQL.Client.Abstractions |  |  |
| GraphQL.Client.Abstractions.Websocket |  |  |
| GraphQL.Client.LocalExecution |  |  |
| GraphQL.Client.Serializer.Newtonsoft |  |  |
| GraphQL.Client.Serializer.SystemTextJson |  |  |
| GraphQL.Primitives |  |  |
The Library will try to follow the following standards and documents:
// 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.
var heroRequest = new GraphQLRequest {
Query = """
{
hero {
name
}
}
"""
};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 aList<byte>first, which will tell the serializer to output a list of numbers instead of a base64-encoded string.
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
datafield.A common mistake is to try to directly use the
PersonTypeclass as response type (because thats the thing you actually want to query), but the returned response object contains a propertypersoncontaining aPersonTypeobject (like theResponseTypemodelled above).
public class UserJoinedSubscriptionResult {
public ChatUser UserJoined { get; set; }
public class ChatUser {
public string DisplayName { get; set; }
public string Id { get; set; }
}
}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")
});subscription.Dispose();.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, the GraphQLQuery value record type is provided:
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=" });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: