DotNetBrightener.Integration.GraphQL 1.0.0-beta-003

GraphQL Integration

DotNetBrightener.Integration.GraphQL is a library that provides APIs to integrate with GraphQL in your Asp.Net Core project with minimal efforts.

If you are not familar with GraphQL, check out https://github.com/facebook/graphql and https://graphql-dotnet.github.io/docs/getting-started

Feature:

• WebAPI-like approach of implementing GraphQL
• Modular, only depends on GraphQL DotNet library

TODO:

[ ] Authorization to the exposing APIs [ ]

Installation

You can install the library from Nuget Package Management on Visual Studio. Require .Net 5.0. Follow instructions on https://www.nuget.org/packages/DotNetBrightener.Integration.GraphQL for installation options.

Usage

1. Register GraphQL Integration to IServiceCollection In your Startup.ConfigureService(IServiceCollection services) method, add the following:

services.EnableGraphQL();

If you have your graph types in the same assembly as Startup class, the above code will automatically register all the types.

Otherwise, assuming you have YourGraphType in a separate assembly, then add the reference to that assembly and use the following to register your graph types.

var assembly = typeof(YourGraphType).Assembly;
services.AddGraphTypes(assembly);

2. Register GraphQL Integration Middleware

In your Startup.Configure() method, add the following to register the middleware to your application

var graphQLEndpoint = "/[your-desired-endpoint]"; // default is /graphql if you don't specify
app.UseGraphQLIntegration(graphQLEndpoint);

3. Define your first model (GraphType) -- TODO