README.md
1# graphql [](https://travis-ci.org/graphql-go/graphql) [](https://godoc.org/github.com/graphql-go/graphql) [](https://coveralls.io/github/graphql-go/graphql?branch=master) [](https://gitter.im/graphql-go/graphql?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2
3An implementation of GraphQL in Go. Follows the official reference implementation [`graphql-js`](https://github.com/graphql/graphql-js).
4
5Supports: queries, mutations & subscriptions.
6
7### Documentation
8
9godoc: https://godoc.org/github.com/graphql-go/graphql
10
11### Getting Started
12
13To install the library, run:
14```bash
15go get github.com/graphql-go/graphql
16```
17
18The following is a simple example which defines a schema with a single `hello` string-type field and a `Resolve` method which returns the string `world`. A GraphQL query is performed against this schema with the resulting output printed in JSON format.
19
20```go
21package main
22
23import (
24 "encoding/json"
25 "fmt"
26 "log"
27
28 "github.com/graphql-go/graphql"
29)
30
31func main() {
32 // Schema
33 fields := graphql.Fields{
34 "hello": &graphql.Field{
35 Type: graphql.String,
36 Resolve: func(p graphql.ResolveParams) (interface{}, error) {
37 return "world", nil
38 },
39 },
40 }
41 rootQuery := graphql.ObjectConfig{Name: "RootQuery", Fields: fields}
42 schemaConfig := graphql.SchemaConfig{Query: graphql.NewObject(rootQuery)}
43 schema, err := graphql.NewSchema(schemaConfig)
44 if err != nil {
45 log.Fatalf("failed to create new schema, error: %v", err)
46 }
47
48 // Query
49 query := `
50 {
51 hello
52 }
53 `
54 params := graphql.Params{Schema: schema, RequestString: query}
55 r := graphql.Do(params)
56 if len(r.Errors) > 0 {
57 log.Fatalf("failed to execute graphql operation, errors: %+v", r.Errors)
58 }
59 rJSON, _ := json.Marshal(r)
60 fmt.Printf("%s \n", rJSON) // {“data”:{“hello”:”world”}}
61}
62```
63For more complex examples, refer to the [examples/](https://github.com/graphql-go/graphql/tree/master/examples/) directory and [graphql_test.go](https://github.com/graphql-go/graphql/blob/master/graphql_test.go).
64
65### Third Party Libraries
66| Name | Author | Description |
67|:-------------:|:-------------:|:------------:|
68| [graphql-go-handler](https://github.com/graphql-go/graphql-go-handler) | [Hafiz Ismail](https://github.com/sogko) | Middleware to handle GraphQL queries through HTTP requests. |
69| [graphql-relay-go](https://github.com/graphql-go/graphql-relay-go) | [Hafiz Ismail](https://github.com/sogko) | Lib to construct a graphql-go server supporting react-relay. |
70| [golang-relay-starter-kit](https://github.com/sogko/golang-relay-starter-kit) | [Hafiz Ismail](https://github.com/sogko) | Barebones starting point for a Relay application with Golang GraphQL server. |
71| [dataloader](https://github.com/nicksrandall/dataloader) | [Nick Randall](https://github.com/nicksrandall) | [DataLoader](https://github.com/facebook/dataloader) implementation in Go. |
72
73### Blog Posts
74- [Golang + GraphQL + Relay](http://wehavefaces.net/)
75
76
){kind=link}
){kind=link}
){kind=link}
){kind=link}