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

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

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

If you want to serve Banana Cake Pop on a separate endpoint, you can use MapBananaCakePop() method:

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

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

Disable the Middleware

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

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

Serve Modes

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

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

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

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

Configuration Options

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

Here is an example of how to set these options:

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