Table of Contents

Namespace HotChocolate.AspNetCore

Classes

DefaultHttpRequestInterceptor

The HTTP request interceptor allows to manipulate the GraphQL request creation and the GraphQL request response creation.

DefaultSocketSessionInterceptor
GraphQLHttpOptions

Represents the GraphQL HTTP options.

GraphQLRequestException
GraphQLServerOptions

Represents the GraphQL server options.

GraphQLSocketOptions

Options relevant to GraphQL over Websocket.

GraphQLToolOptions

Represents the GraphQL tool options for Banana Cake Pop.

GraphQLToolServeMode

Represents the different modes of serving the Banana Cake Pop GraphQL tool. This class enables serving the tool in a variety of predefined ways:

  • Latest: Uses the latest version of the tool, served over the cdn.
  • Insider: Uses the insider version of the tool, served over the CDN.
  • Embedded: Uses the tool's embedded files in the package.
In addition, a specific version of the tool can be served over the CDN using the Version(string) method.

The following example shows how to serve the embedded version of the tool: 

endpoints
  .MapGraphQL()
  .WithOptions(new GraphQLServerOptions
    {
      Tool = { ServeMode = GraphQLToolServeMode.Embedded }
    });

Or when you want to serve the insider version of the tool: 

endpoints
  .MapGraphQL()
  .WithOptions(new GraphQLServerOptions
    {
      Tool = { ServeMode = GraphQLToolServeMode.Insider }
    });

Or when you want to serve a specific version of the tool: 

endpoints
  .MapGraphQL()
  .WithOptions(new GraphQLServerOptions
    {
      Tool = { ServeMode = GraphQLToolServeMode.Version("5.0.8") }
    });
HttpGetMiddleware
HttpGetSchemaMiddleware
HttpMultipartMiddleware
HttpPostMiddleware
HttpPostMiddlewareBase
MiddlewareBase

The Hot Chocolate ASP.NET core middleware base class.

WebSocketSubscriptionMiddleware

Structs

AcceptMediaType

Representation of a single media type entry from the accept header.

Interfaces

IHttpRequestInterceptor

The HTTP request interceptor allows to manipulate the GraphQL request creation and the GraphQL request response creation.

ISocketSessionInterceptor

The socket interceptor allows to customize the GraphQL over Websocket behavior.

Enums

AcceptMediaTypeKind

Representation of well-known media kinds. We use this to avoid constant string comparison.

AllowedGetOperations
DefaultHttpMethod

The default HTTP fetch method for Banana Cake Pop.

HttpTransportVersion

Represents the GraphQL over HTTP transport version.

MiddlewareRoutingType

Defines if middlewares are explicitly hosted through routing or of they are all included into one route.

RequestContentType

Specifies the GraphQL request content types that hot chocolate supports.

ResponseContentType

Specifies the GraphQL response content types that hot chocolate supports.

Delegates

HttpRequestInterceptorDelegate