TGraphQLWebBrokerDispatcher Class

The component to be used in a WebBroker application to process GraphQL HTTP requests.

Remarks

Use TGraphQLWebBrokerDispatcher component to add GraphQL capabilities to a Web Broker application. When you drop this component in a data module descending from TWebModule, it will automatically process any GraphQL HTTP requests arriving at the endpoint specified by Endpoint property (which is "graphql/" by default). You need to associate a TGraphQLSchema component to the Schema property. Such GraphQL schema will be used to process the requests. You can also use Options property to better configure the GraphQL server behavior, for example, enabling GraphQL Playground by setting the TGraphQLHttpOptions.PlaygroundEnabled to true.

Syntax

Unit: GraphQL.WebBroker

TGraphQLWebBrokerDispatcher = class(TComponent, IWebDispatch);

Methods

Name	Description
CurrentSchema	Returns the schema document used by the GraphQL server.

Properties

Name	Description
Endpoint	Specifies the endpoint of the GraphQL server. Default is "graphql/".
Options	Provides a set of options you can use to customize the GraphQL server.
Schema	The associated schema component which will provide the schema document used by the server. This property is required.