io.vertx.ext.web.handler.graphql

## Interface GraphiQLHandlerBuilder

-     public interface GraphiQLHandlerBuilder

  A builder for `GraphiQLHandler` instances.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `GraphiQLHandlerBuilder` | `addingHeaders(java.util.function.Function<RoutingContext,MultiMap> factory)` Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface.
    `GraphiQLHandler` | `build()`
    `GraphiQLHandlerBuilder` | `with(GraphiQLHandlerOptions options)` Change the `GraphiQLHandlerOptions` to use.

- - ### Method Detail

    - #### with

          GraphiQLHandlerBuilder with(GraphiQLHandlerOptions options)

      Change the `GraphiQLHandlerOptions` to use.
      Returns:
        a reference to this, so the API can be used fluently

    - #### addingHeaders

          GraphiQLHandlerBuilder addingHeaders(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

    - #### build

          GraphiQLHandler build()

      Returns:
        a new instance of `GraphiQLHandler`

Copyright © 2024 Eclipse. All rights reserved.