package
0.0.0-20231012004527-77189e400b6e
Repository: https://github.com/dagger/graphql-go-tools.git
Documentation: pkg.go.dev

# README

graphql-go-tools-handler

Fork of https://github.com/graphql-go/handler with some changes

Usage

func main() {
	schema, _ := graphql.NewSchema(...)

	h := handler.New(&handler.Config{
		Schema: &schema,
		Pretty: true,
		GraphiQL: handler.NewDefaultGraphiQLConfig(),
	})

	http.Handle("/graphql", h)
	http.ListenAndServe(":8080", nil)
}

Using Playground

h := handler.New(&handler.Config{
	Schema: &schema,
	Pretty: true,
	Playground: handler.NewDefaultPlaygroundConfig(),,
})

Details

The handler will accept requests with the parameters:

  • query: A string GraphQL document to be executed.

  • variables: The runtime values to use for any GraphQL query variables as a JSON object.

  • operationName: If the provided query contains multiple named operations, this specifies which operation should be executed. If not provided, an 400 error will be returned if the query contains multiple named operations.

GraphQL will first look for each parameter in the URL's query-string:

/graphql?query=query+getUser($id:ID){user(id:$id){name}}&variables={"id":"4"}

If not found in the query-string, it will look in the POST request body. The handler will interpret it depending on the provided Content-Type header.

  • application/json: the POST body will be parsed as a JSON object of parameters.

  • application/x-www-form-urlencoded: this POST body will be parsed as a url-encoded string of key-value pairs.

  • application/graphql: The POST body will be parsed as GraphQL query string, which provides the query parameter.

# Functions

New creates a new handler.
NewConfig returns a new default config.
NewDefaultGraphiQLConfig creates a new default config.
NewDefaultPlaygroundConfig creates a new default config.
NewRequestOptions Parses a http.Request into GraphQL request options struct.

# Constants

# Variables

GraphiqlVersion is the current version of GraphiQL.
PlaygroundVersion the default version to use.

# Structs

Config configuration.
GraphiQLConfig a configuration for graphiql.
Handler handler.
PlaygroundConfig playground configuration.
RequestOptions options.

# Type aliases

ResultCallbackFn result callback.
RootObjectFn allows a user to generate a RootObject per request.