By default, when you map your GraphQL endpoints using MapGraphQL(), Nitro is automatically served at the /graphql endpoint.

app.UseEndpoints(endpoints =>
{
    endpoints.MapGraphQL();
});

In the example above, the GraphQL service and Nitro are both mapped to the /graphql endpoint.

If you want to serve Nitro on a separate endpoint, you can use MapNitroApp() method:

app.UseEndpoints(endpoints =>
{
    endpoints.MapGraphQL();
    endpoints.MapNitroApp("/my-graphql-ui");
});

In this configuration, the GraphQL service remains at the /graphql endpoint, and Nitro is served at the /my-graphql-ui endpoint.

Disable the Middleware

In some scenarios, you may not want to serve Nitro, e.g., in a production environment. You can disable Nitro by setting the Enable property to false:

endpoints
  .MapGraphQL()
  .WithOptions(
    new GraphQLServerOptions
    {
      Tool =
      {
        Enable = false
      }
    });

Serve Modes

The ServeMode property controls which version of Nitro to serve. The default mode is Latest, serving the most recent version of Nitro from a CDN. You can also serve the embedded version (Embedded) of Nitro, which is included in the package.

• Latest: Serves the latest version of Nitro from a CDN.
• Insider: Serves the insider version of Nitro from a CDN, allowing preview of upcoming features.
• Embedded: Serves the embedded version of Nitro that comes with the package.
• Version(string version): Serves a specific version of Nitro from the CDN.

Depending on your environment or preferences, you can choose the appropriate mode:

endpoints
  .MapNitroApp()
  .WithOptions(new GraphQLToolOptions
  {
      ServeMode = GraphQLToolServeMode.Embedded
  });

Configuration Options

You can tailor Nitro to your needs by setting various options via the GraphQLToolOptions class. You can specify these options using the WithOptions() method in both MapGraphQL() and MapNitroApp() methods.

Here is an example of how to set these options:

endpoints
  .MapNitroApp()
  .WithOptions(new GraphQLToolOptions
  {
      ServeMode = GraphQLToolServeMode.Insider,
      Title = "My GraphQL API",
      Document = "Query { hello }",
      GraphQLEndpoint = "/api/graphql",
      IncludeCookies = true,
      Enable = true
  });