io.vertx.ext.web.handler.graphql.GraphiQLHandler Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.vertx.ext.web.handler.graphql;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.handler.graphql.impl.GraphiQLHandlerImpl;
import java.util.function.Function;
/**
* A {@link io.vertx.ext.web.Route} handler for GraphiQL resources.
*
* @author Thomas Segismont
*/
@VertxGen
public interface GraphiQLHandler extends Handler {
/**
* Create a new {@link GraphiQLHandler}.
*
* The handler will be configured with default {@link GraphiQLHandlerOptions options}.
*/
static GraphiQLHandler create() {
return create(new GraphiQLHandlerOptions());
}
/**
* Create a new {@link GraphiQLHandler}.
*
* The handler will be configured with the given {@code options}.
*
* @param options options for configuring the {@link GraphiQLHandler}
*/
static GraphiQLHandler create(GraphiQLHandlerOptions options) {
return new GraphiQLHandlerImpl(options);
}
/**
* 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 {@link GraphiQLHandlerOptions#getHeaders()}.
*
* This can be useful if, for example, the server is protected by authentication.
*
* @return a reference to this, so the API can be used fluently
*/
@Fluent
GraphiQLHandler graphiQLRequestHeaders(Function factory);
}