Specification

Usage

Create a GraphQLHttpClient

// To use NewtonsoftJsonSerializer, add a reference to// NuGet package GraphQL.Client.Serializer.NewtonsoftvargraphQLClient=newGraphQLHttpClient("https://api.example.com/graphql",newNewtonsoftJsonSerializer());

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:

varheroRequest=newGraphQLRequest{Query="""    {        hero {            name        }    }    """};

OperationName and Variables Request:

varpersonAndFilmsRequest=newGraphQLRequest{Query="""    query PersonAndFilms($id: ID) {        person(id: $id) {            name            filmConnection {                films {                    title                }            }        }    }    """,OperationName="PersonAndFilms",Variables=new{id="cGVvcGxlOjE="}};

Warning

Be careful when usingbyte[] in your variables object, as most JSON serializers will treat that as binary data.

If you really need to send alist of bytes with abyte[] 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.

Execute Query/Mutation

publicclassResponseType{publicPersonTypePerson{get;set;}}publicclassPersonType{publicstringName{get;set;}publicFilmConnectionTypeFilmConnection{get;set;}}publicclassFilmConnectionType{publicList<FilmContentType>Films{get;set;}}publicclassFilmContentType{publicstringTitle{get;set;}}vargraphQLResponse=awaitgraphQLClient.SendQueryAsync<ResponseType>(personAndFilmsRequest);varpersonName=graphQLResponse.Data.Person.Name;

vargraphQLResponse=awaitgraphQLClient.SendQueryAsync(personAndFilmsRequest,()=>new{person=newPersonType()});varpersonName=graphQLResponse.Data.person.Name;

Important

Note that the field in the GraphQL response which gets deserialized into the response object is thedata field.

A common mistake is to try to directly use thePersonType class as response type (because thats thething you actually want to query), but the returned response object contains a propertyperson containing aPersonType object (like theResponseType modelled above).

Use Subscriptions

publicclassUserJoinedSubscriptionResult{publicChatUserUserJoined{get;set;}publicclassChatUser{publicstringDisplayName{get;set;}publicstringId{get;set;}}}

Create subscription

varuserJoinedRequest=newGraphQLRequest{Query=@"    subscription {        userJoined{            displayName            id        }    }"};IObservable<GraphQLResponse<UserJoinedSubscriptionResult>>subscriptionStream=client.CreateSubscriptionStream<UserJoinedSubscriptionResult>(userJoinedRequest);varsubscription=subscriptionStream.Subscribe(response=>{Console.WriteLine($"user '{response.Data.UserJoined.DisplayName}' joined")});

End Subscription

subscription.Dispose();

Automatic persisted queries (APQ)

GraphQLQueryquery=new("""                         query PersonAndFilms($id: ID) {                             person(id: $id) {                                 name                                 filmConnection {                                     films {                                         title                                     }                                 }                             }                         }                         """);vargraphQLResponse=awaitgraphQLClient.SendQueryAsync<ResponseType>(query,"PersonAndFilms",new{id="cGVvcGxlOjE="});

Syntax Highlighting for GraphQL strings in IDEs

Useful Links

Blazor WebAssembly Limitations