Feather.GraphQL.Linq.Abstractions 0.1.1-alpha.13

Feather.GraphQL

A GraphQL Client for .NET Standard over HTTP.

Specification

The Library will try to follow the following standards and documents:

• GraphQL Specification
• GraphQL HomePage

Usage

This library provides various extensions and utilities to extend base .NET networking functionality with GraphQL concepts.

If you're familiar with the System.Text.Json extensions to HttpClient, this was designed to be familiar!

Create a GraphQLRequest:

Simple Request:

var heroRequest = new GraphQLRequest {
    Query = """
    {
        hero {
            name
        }
    }
    """
};

OperationName and Variables Request:

Execute Query/Mutation

Assuming the schema:

type Query
{
    person: Person
}

type Person
{
    name: String!
    filmConnection: FilmConnection!
}

type FilmConnection {
    films: [FilmContent!]
}

type FilmContent {
    title: String!
}

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

// Use an HTTP client from somewhere (DI, Factory, etc)
var httpResponse = await httpClient.SendGraphQLQueryAsync(personAndFilmsRequest);

// Read the response headers/content similar to string or JSON data
var graphQLResponse = httpResponse.Content.ReadAsGraphQLAsync<PersonResponse>();

// Get the information you need out of the response
var personName = graphQLResponse.Data.Person.Name;

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.

Useful Links

• StarWars Example Server (GitHub)

• StarWars Example Server (EndPoint)

• GitHub GraphQL API Docs

• GitHub GraphQL Explorer

• GitHub GraphQL Endpoint

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:

• ClientCertificates
• UseDefaultCredentials