io.vertx.ext.web.handler.graphql

Interface GraphiQLHandler

All Superinterfaces:

Handler<RoutingContext>

public interface GraphiQLHandler
extends Handler<RoutingContext>

A Route handler for GraphiQL resources.

Author:

Thomas Segismont

Method Summary

Modifier and Type	Method and Description
static GraphiQLHandler	create() Create a new GraphiQLHandler.
static GraphiQLHandler	create(GraphiQLHandlerOptions options) Create a new GraphiQLHandler.
GraphiQLHandler	graphiQLRequestHeaders(java.util.function.Function<RoutingContext,MultiMap> factory) Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface.

Methods inherited from interface io.vertx.core.Handler

handle

Method Detail

create

static GraphiQLHandler create()

Create a new GraphiQLHandler.

The handler will be configured with default options.

create

static GraphiQLHandler create(GraphiQLHandlerOptions options)

Create a new GraphiQLHandler.

The handler will be configured with the given options.

Parameters:

options - options for configuring the GraphiQLHandler

graphiQLRequestHeaders

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

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