Part of Anarchy I/O Toolkit, a .NET developer platform · Pillar: Infrastructure · Layer: Web · Package catalog

GraphQL wiring for ASP.NET Core APIs built on the toolkit’s web pipeline.

dotnet add package Anarchy.Toolkit.Web.GraphQL
  • Define your schema using SchemaBase and register it with AddToolkitGraphQl<TSchema>(graphTypesAssembly). Register root graph types separately.
  • Add the endpoint and GraphiQL playground middleware with UseToolkitGraphQl<TSchema>(authorizationPolicy).
  • GraphQlRoutes provides route conventions; the GraphQL endpoint requires the supplied authorization policy.

When to use it

Add this package when an ASP.NET Core application needs a GraphQL endpoint alongside, or instead of, REST routes. It wires graphql-dotnet into the host; your application supplies its schema, query and mutation types, resolvers and authorization policy.

How to use it

  1. Define a schema (optionally deriving from SchemaBase) and set its query and any mutation or subscription roots. Register root graph types and their application services in DI.
  2. Register the schema and discover graph types from the appropriate assembly. Add the middleware with the name of an authorization policy already configured by the host:
using Anarchy.Toolkit.Web.GraphQL.Extension.DependencyInjection;
using Anarchy.Toolkit.Web.GraphQL.Extension.Service.Builder;

services.AddToolkitGraphQl<MySchema>(typeof(MySchema).Assembly);
// In the configured ASP.NET Core pipeline:
app.UseToolkitGraphQl<MySchema>("MyGraphQlPolicy");

Replace MySchema and the policy name with your application types. Optional path arguments override the endpoint and GraphiQL routes. The GraphQL endpoint requires the supplied policy; evaluate whether the separately served GraphiQL UI should be exposed in each environment.

See the endpoint guide and toolkit overview.

Releases

See the release notes for the complete release history.