graphql-go-handler
Golang HTTP.Handler for graphl-go
Usage
package main
import (
"net/http"
"github.com/graphql-go/handler"
)
func main() {
schema, _ := graphql.NewSchema(...)
h := handler.New(&handler.Config{
Schema: &schema,
Pretty: true,
GraphiQL: true,
})
http.Handle("/graphql", h)
http.ListenAndServe(":8080", nil)
}
Using Playground
h := handler.New(&handler.Config{
Schema: &schema,
Pretty: true,
GraphiQL: false,
Playground: true,
})
Using Multipart Form Uploads
This handler supports the GraphQL multipart request specification. All file uploads will be made available as the following Scalar that you can add to your GraphQL schemas
var UploadScalar = graphql.NewScalar(graphql.ScalarConfig{
Name: "Upload",
ParseValue: func(value interface{}) interface{} {
if v, ok := value.(*handler.MultipartFile); ok {
return v
}
return nil
},
})
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 providedquery
contains multiple named operations, this specifies which operation should be executed. If not provided, an 400 error will be returned if thequery
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 thequery
parameter. -
multipart/form-data
: The POST body will be parsed as GraphQL query string, which provides theoperations
parameter. GraphQL multipart request specification
Examples
Test
$ go get github.com/graphql-go/handler
$ go build && go test ./...