io.vertx.ext.web.handler.graphql

Interface GraphiQLHandler

All Superinterfaces:

Handler<RoutingContext>

public interface GraphiQLHandler
extends Handler<RoutingContext>

A handler for GraphiQL resources.

Author:

Thomas Segismont

Method Summary

Modifier and Type	Method and Description
static GraphiQLHandlerBuilder	builder(Vertx vertx) Create a new GraphiQLHandlerBuilder with default GraphiQLHandlerOptions.
static GraphiQLHandler	create() Deprecated. as of 4.5.1, use create(Vertx), with router()
static GraphiQLHandler	create(GraphiQLHandlerOptions options) Deprecated. as of 4.5.1, use create(Vertx, GraphiQLHandlerOptions), with router()
static GraphiQLHandler	create(Vertx vertx) Create a new GraphiQLHandler.
static GraphiQLHandler	create(Vertx vertx, GraphiQLHandlerOptions options) Create a new GraphiQLHandler.
GraphiQLHandler	graphiQLRequestHeaders(java.util.function.Function<RoutingContext,MultiMap> factory) Deprecated. as of 4.5.1, use builder(Vertx) instead
Router	router() Creates a router configured to serve GraphiQL resources.

Methods inherited from interface io.vertx.core.Handler

handle

Method Detail

builder

static GraphiQLHandlerBuilder builder(Vertx vertx)

Create a new GraphiQLHandlerBuilder with default GraphiQLHandlerOptions.

create

static GraphiQLHandler create(Vertx vertx)

Create a new GraphiQLHandler.

The handler will be configured with default options.

create

@Deprecated
static GraphiQLHandler create()

Deprecated. as of 4.5.1, use create(Vertx), with router()

Create a new GraphiQLHandler.

The handler will be configured with default options.

create

static GraphiQLHandler create(Vertx vertx,
                              GraphiQLHandlerOptions options)

Create a new GraphiQLHandler.

The handler will be configured with the given options.

Parameters:

options - options for configuring the GraphiQLHandler

create

@Deprecated
static GraphiQLHandler create(GraphiQLHandlerOptions options)

Deprecated. as of 4.5.1, use create(Vertx, GraphiQLHandlerOptions), with router()

Create a new GraphiQLHandler.

The handler will be configured with the given options.

Parameters:

options - options for configuring the GraphiQLHandler

router

Router router()

Creates a router configured to serve GraphiQL resources.

Returns:

a router to be mounted on an existing Route

See Also:

Route.subRouter(Router)

graphiQLRequestHeaders

@Deprecated
GraphiQLHandler graphiQLRequestHeaders(java.util.function.Function<RoutingContext,MultiMap> factory)

Deprecated. as of 4.5.1, use builder(Vertx) instead

Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface. The result will be applied on top of the fixed set of headers specified in GraphiQLHandlerOptions.getHeaders().

This can be useful if, for example, the server is protected by authentication.

Returns:

a reference to this, so the API can be used fluently