What is the difference between graphql-dotnet/graphql-dotnet/ and graphql-dotnet/server/

Question

Good morning.

I am a bit confused about these two repositories(graphql-dotnet/graphql-dotnet/ and graphql-dotnet/server/).

https://github.com/graphql-dotnet/graphql-dotnet/ and https://github.com/graphql-dotnet/server

They are both under the same organization and there is some overlap of contributors, but I'm a bit lost about deciding which one to use.

I would like to build a dotnet 5 application that hosts a graphql endpoint. In a nutshell that is my goal.

I noticed that the graphql-dotnet/server/repository has inbuilt some helpers such as.

 serviceCollection
                    .AddGraphQL((options, provider) =>
                    {
                        options.EnableMetrics = HostEnvironment.IsDevelopment();
                        var logger = provider.GetRequiredService<ILogger<Startup>>();
                        options.UnhandledExceptionDelegate = ctx => logger.LogError("{Error} occurred", ctx.OriginalException.Message);
                    })
                    .AddSystemTextJson()
                    .AddErrorInfoProvider(opt => opt.ExposeExceptionStackTrace = HostEnvironment.IsDevelopment())
                    .AddWebSockets() 
                    .AddDataLoader() 
                    .AddGraphTypes(typeof(ApplicationSchema))

Which allows my DI to be setup nice and easy. Its counterpart, the graphql-dotnet/graphql-dotnet/ does not.

So my question is "which one should I use exclusivly? Which one is recomended, by secondary goals are to add jwt authentication and finally federation support. But those two are far down the line.

One of my coworkers went ahead and used graphql-dotnet/graphql-dotnet/ and his server application has a lot more configuration than the documentation of graphql-dotnet/server/ so how do I know which one do I use?

Can any one recommend any documentation that highlights the difference between the two of them?

Joe McBride · Accepted Answer · 2021-03-29T13:23:29.940

2

The main graphql-dotnet repo is the "core" library of GraphQL components. The server repo contains ASP.NET specific extensions. It uses the core library. If you use the server project, you are also using the core library.

GraphQL itself can be used with any protocol, it is not required to be used with HTTP or JSON. So the core library does not have any HTTP or ASP.NET dependencies.

If you are using ASP.NET, then the server project is the quickest way to get started. If you want to use Subscriptions, then the server project provides that functionality.

If you don't need subscriptions and if you want a bit more control over how the framework handles the HTTP request, then it would be easier to write your own controller or middleware.

Using JWT authentication is handled by ASP.NET and can be used in either scenario. Federation can also be used in either scenario.

edited Mar 29 '21 at 13:23

answered Mar 29 '21 at 05:27

Joe McBride

3,789
2
34
38

Regarding Federation, is there any documentation on how set it up? Im looking to connect with other non-dotnet graph server. – Alejandro Gonzalez Mar 29 '21 at 12:45
Here's some basic docs from when the feature was implemented: https://github.com/graphql-dotnet/graphql-dotnet/pull/1233 Here's the Apollo example repo with the Account endpoint replaced with a GraphQL .NET service: https://github.com/joemcbride/gql-presentation/blob/master/demos/6%20-%20federation/services/accounts/ Note that the example uses a 3.0 preview version, and a few things have changed since then (mainly separate nuget packages for JSON serialization). – Joe McBride Mar 29 '21 at 13:14

What is the difference between graphql-dotnet/graphql-dotnet/ and graphql-dotnet/server/

1 Answers1