GraphQL.Relay
0.9.1
dotnet add package GraphQL.Relay --version 0.9.1
NuGet\Install-Package GraphQL.Relay -Version 0.9.1
<PackageReference Include="GraphQL.Relay" Version="0.9.1" />
paket add GraphQL.Relay --version 0.9.1
#r "nuget: GraphQL.Relay, 0.9.1"
// Install GraphQL.Relay as a Cake Addin
#addin nuget:?package=GraphQL.Relay&version=0.9.1
// Install GraphQL.Relay as a Cake Tool
#tool nuget:?package=GraphQL.Relay&version=0.9.1
GraphQL.Relay
A collection of classes, tools, and utilities for creating Relay.js compatible GraphQL servers in dotnet.
Provides the following packages:
Package | Downloads | NuGet Latest |
---|---|---|
GraphQL.Relay |
Usage
Setup
Add the Nuget package:
$> dotnet add package GraphQL.Relay
Ensure your resolver for GraphQL can resolve:
ConnectionType<>
EdgeType<>
NodeInterface
PageInfoType
If you're using the resolver from MVC (IServiceProvider
), that might look like this:
services.AddTransient(typeof(ConnectionType<>));
services.AddTransient(typeof(EdgeType<>));
services.AddTransient<NodeInterface>();
services.AddTransient<PageInfoType>();
GraphTypes
Included are a few GraphQL types and helpers for creating Connections, Mutations, and Nodes
QueryGraphType
A top level Schema query type, which defines the required node
root query;
public class StarWarsQuery : QueryGraphType
{
public StarWarsQuery() {
Field<DroidType>(
"hero",
resolve: context => new Droid { DroidId = "1", Name = "R2-D2" }
);
}
}
public class StarWarsSchema : Schema
{
public StarWarsSchema() {
Query = new StarWarsQuery();
}
}
NodeGraphType<TSource, TOut>
, NodeGraphType<TSource>
, NodeGraphType
NodeTypes, are ObjectGraphType
s that implement the NodeInterface
and provide a GetById
method, which allows Relay (via the node()
Query) to refetch nodes when it needs to.
Nodes, also provide a convenient Id()
method for defining global id
fields, derived from the type Name
and Id
.
If your underlying type has a name conflict on the field id
, the "local" Id will be prefixed with the type name,
e.g. Droid.Id -> droidId
public class Droid
{
public string DroidId { get; set; }
public string Name { get; set; }
}
public class DroidType : NodeGraphType<Droid>
{
public DroidType()
{
Name = "Droid";
Id(d => d.DroidId); // adds an id Field as well as the `Droid` id field
Field<StringGraphType>("name", "The name of the droid.");
}
public override Droid GetById(string droidId) {
return StarWarsData.GetDroidByIdAsync(droidId);
}
}
Mutations
Relay mutations specify a few constraints on top of the general GraphQL mutations. To accommodate this, there are mutation specific GraphTypes provided.
MutationGraphType
The top level mutation type attached to the GraphQL Schema
public class StarWarsMutation : MutationGraphType
{
public StarWarsMutation() {
Mutation<CreateDroidInput, CreateDroidPayload>("createDroid");
Mutation<DeleteDroidInput, DeleteDroidPayload>("deleteDroid");
}
}
public class StarWarsSchema : Schema
{
public StarWarsSchema() {
Query = new StarWarsQuery();
Mutation = new StarWarsMutation();
}
}
MutationInputGraphType
An simple base class that defines a clientMutationId
field. functionally identical to InputObjectGraphType
otherwise
MutationPayloadGraphType<TSource, TOut>
, MutationPayloadGraphType<TSource>
, MutationPayloadGraphType
The output ObjectGraphType containing the mutation payload, functionally similar to an ObjectGraphType
with the
addition of requiring a MutateAndGetPayload()
method used to resolve the payload from the inputs.
public class CreateDroidPayload : MutationPayloadGraphType<DroidPayload, Task<DroidPayload>>
{
public CreateDroidPayload()
{
Name = "CreateDroidPayload";
Field(
name: "droid",
type: typeof(Droid));
}
public override async Task<DroidPayload> MutateAndGetPayload(MutationInputs inputs)
{
string name = inputs.Get<string>("name");
Droid newDroid = await StarWarsData.CreateDroidAsync(name)
return new DroidPayload {
Droid = newDroid
};
}
}
Connections
Luckily GraphQL-dotnet
already provides helpful utilities for creating connection fields, on GraphTypes. In addition
included here are a few more helpful methods for creating relay compatible Connections from IEnumerables.
Connection.ToConnection(IEnumerable items, ResolveConnectionContext context)
Creates a connection from an existing list of objects.
public class Droid
{
public string DroidId { get; set; }
public string Name { get; set; }
public IEnumerable<Droid> Friends { get; set; }
}
public class DroidType : ObjectGraphType<Droid>
{
public DroidType()
{
Name = "Droid";
Field<StringGraphType>("name", "The name of the droid.");
Connection<DroidType>()
.Name("friends")
.Resolve(context =>
ConnectionUtils.ToConnection(c.Source.Friends, context));
}
}
ConnectionUtils.ToConnection(IEnumerable items, ResolveConnectionContext context, int sliceStartIndex, int totalCount)
Similar to the above, but creates a connection with the correct cursors, when you only have a slice of the entire set of items. Windowing the items based on the arguments.
ConnectionUtils.CursorToOffset(string cursor)
Convert a connection item cursor to the int
index of the item in the set.
ConnectionUtils.OffsetToCursor(int offset)
Convert an index offset to a connection cursor.
ResolveConnectionContextExtensions.ToConnection<TSource>(this IResolveConnectionContext context, IQueryable<TSource> items)
Creates a connection from an IQueryable.
public class Droid
{
public string DroidId { get; set; }
public string Name { get; set; }
public IQueryable<Droid> Friends { get; set; }
}
public class DroidType : ObjectGraphType<Droid>
{
public DroidType()
{
Name = "Droid";
Field<StringGraphType>("name", "The name of the droid.");
Connection<DroidType>()
.Name("friends")
.Resolve(context => context
.ToConnection(c.Source.Friends));
}
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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. |
-
.NETStandard 2.0
- GraphQL (>= 7.0.2)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on GraphQL.Relay:
Package | Downloads |
---|---|
VirtoCommerce.ExperienceApiModule.Core
Experiene API functionality |
|
EPiGraphQL.Api
Plug and play EPiServer GraphQL service |
|
Graphify.EPiServer.Api
Plug and play EPiServer GraphQL service |
|
VirtoCommerce.Xapi.Core
Experiene API functionality |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.9.1 | 36,176 | 10/11/2022 |
0.9.0 | 1,350 | 10/7/2022 |
0.8.0 | 30,320 | 7/1/2022 |
0.7.0 | 551 | 6/27/2022 |
0.6.2 | 339,090 | 7/20/2021 |
0.5.0 | 432,018 | 11/13/2017 |
0.5.0-alpha.0 | 739 | 4/15/2018 |
0.4.1 | 7,209 | 1/10/2017 |
0.4.0 | 1,061 | 1/9/2017 |
0.3.0 | 1,033 | 1/9/2017 |
0.2.0 | 1,175 | 1/2/2017 |
0.1.0-beta4 | 852 | 12/20/2016 |
0.1.0-beta3 | 869 | 12/12/2016 |
0.1.0-beta2 | 811 | 12/12/2016 |
0.1.0-beta1 | 851 | 11/25/2016 |