# README

graphql

Low-level GraphQL client for Go.

Simple, familiar API
Respects context.Context timeouts and cancellation
Build and execute any kind of GraphQL request
Use strong Go types for response data
Use variables and upload files
Simple error handling

Installation

Make sure you have a working Go environment. To install graphql, simply run:

$ go get github.com/machinebox/graphql

Usage

import "context"

// create a client (safe to share across requests)
client := graphql.NewClient("https://machinebox.io/graphql")

// make a request
req := graphql.NewRequest(`
    query ($key: String!) {
        items (id:$key) {
            field1
            field2
            field3
        }
    }
`)

// set any variables
req.Var("key", "value")

// set header fields
req.Header.Set("Cache-Control", "no-cache")

// define a Context for the request
ctx := context.Background()

// run it and capture the response
var respData ResponseStruct
if err := client.Run(ctx, req, &respData); err != nil {
    log.Fatal(err)
}

File support via multipart form data

By default, the package will send a JSON body. To enable the sending of files, you can opt to use multipart form data instead using the UseMultipartForm option when you create your Client:

client := graphql.NewClient("https://machinebox.io/graphql", graphql.UseMultipartForm())

Access to raw json response via user supplied function in client

For usage example see method TestProcessResultFunc in file graphql_json_test.go

client := NewClient(srv.URL)
	// enable / disable logging
	client.Log = func(s string) { log.Println(s) }
	// we like our json pretty so this feature was added
	client.IndentLoggedJson = true

    /*
        example of a usage to code generate target response struct
        // slightly modified fork of the jflect command line tool to allow for usage as an api
        "github.com/mathew-bowersox/jflect"

        // example of processing the results json into a struct literal
        strNme := "Results"
        client.ProcessResult = func (r io.Reader) error {
    	err := generate.Generate(r, os.Stdout, &strNme)
    	return err
    }*/

    // here we will test the supplied reader contains correct results
 	client.ProcessResult = func (r io.Reader) error {
	    b := new(bytes.Buffer)
		 _ ,err := io.Copy(b,r)
		 is.True(res == b.String())
		 return err
	}

For more information, read the godoc package documentation or the blog post.