gql

README

GQL

A simple GraphQL client.

License

MIT

Documentation

Index

• Variables
• type Client
  • func NewClient(endpoint string, options *ClientOptions) *Client
  • func (c *Client) Run(ctx context.Context, req *Request, resp interface{}) error
• type ClientOptions
• type Error
  • func (e Error) Error() string
• type Errors
  • func (e Errors) Error() string
• type Request
  • func NewRequest(query string) *Request
• type Response

Variables

var (
	// DefaultOptions are the default set of ClientOptions for a Client
	DefaultOptions = &ClientOptions{
		HTTP: http.DefaultClient,
	}
)

Types

type Client

type Client struct {
	Endpoint string
	Options  *ClientOptions
}

Client is a client aimed at a specific GraphQL endpoint

func NewClient

func NewClient(endpoint string, options *ClientOptions) *Client

NewClient returns a new Client for making GraphQL requests

func (*Client) Run

func (c *Client) Run(ctx context.Context, req *Request, resp interface{}) error

Run runs a given Request using the Client

type ClientOptions

type ClientOptions struct {
	HTTP *http.Client
}

ClientOptions are options that can be set for a Client

type Error

type Error struct {
	Message string `json:"message"`
}

Error is an individual GraphQL error

func (Error) Error

func (e Error) Error() string

Error fills the error interface

type Errors

type Errors []Error

Errors is a collection of GraphQL errors

func (Errors) Error

func (e Errors) Error() string

Error fills the error interface

type Request

type Request struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables"`
	Header    http.Header            `json:"-"`
}

Request is a GraphQL request

func NewRequest

func NewRequest(query string) *Request

NewRequest returns a new Request

type Response

type Response struct {
	Data   interface{} `json:"data"`
	Errors Errors      `json:"errors"`
}

Response is the response to a GraphQL Request