readme.md

gqlclient

The package gqlclient provides a GraphQL client implementation.

Reasons to use gqlclient:

• Simple, familiar API
• Use strong Go types for variables and response data
• Receive a full GraphQL response with data, errors and extensions
• Respects context.Context cancellations and timeouts
• Supports GraphQL Errors with Extensions

Note: This package already works quite well, but it is under heavy development to work towards a v1.0 release. Before that, the API may have breaking changes even with minor versions.

Coming soon:

• Uploads
• Subscriptions
• More options (e.g. http headers)

Installation

Make sure you have a working Go environment, preferably with Go modules.

To install graphql, simply run:

$ go get github.com/steebchen/gqlclient

Quickstart

The recommended way is to use structs depending on your schema for best type-safety.

package main

import (
	"log"
	"context"
	"github.com/steebchen/gqlclient"
)

func main() {
	client := gqlclient.New("https://metaphysics-production.artsy.net")
	
	var data struct {
		Article struct {
			ID  string
			Title string
		}
	}
	
	type variables struct{
		ID string `json:"id"`
	}

	query := `
		query Article($id: String!) {
			article(id: $id) {
				id
				title
			}
		}
	`

	_, err := client.Send(context.Background(), &data, query, variables{
		ID: "55bfed9275de7b060098b9bc",
	})

	if err != nil {
		panic(err)
	}

	log.Printf("data: %+v", data)
	// Output:
	// Article: {
	//   ID: 55bfed9275de7b060098b9bc
	//   Title: How the 1960s’ Most Iconic Artists Made Art Contemporary
	// }
}

If you don't want to use structs, you use Raw() to use maps for both input (variables) and output (response data).

resp, err := client.Raw(context.Background(), query, map[string]interface{}{
  "id": "55bfed9275de7b060098b9bc",
})

if err != nil {
	panic(err)
}

log.Printf("data: %+v", resp.Data)
// Output:
// data: map[
//   article: map[
//	   id: 55bfed9275de7b060098b9bc
//	   title: How the 1960s’ Most Iconic Artists Made Art Contemporary
//   ]
// ]

Both Send() and Raw() always return a GraphQL Response, so you can access GraphQL Errors and Extensions.