graphql

Documentation

Index

• func BuildGraphQLArray(arr []string) string
• func BuildGraphQLEnumArray(v interface{}) string
• func MarshalGQL(v interface{}) string
• type Client
• type DefaultClient
  • func NewClient(_url string, headers map[string]string) (*DefaultClient, error)
  • func (client *DefaultClient) Do(ctx context.Context, req *Request) (*Response, error)
  • func (client *DefaultClient) URL() string
• type Error
• type Marshaller
• type Request
  • func (req *Request) Valid() error
• type Response

Functions

func BuildGraphQLArray

func BuildGraphQLArray(arr []string) string

BuildGraphQLArray builds a GraphQL array for including in queries or mutations.

func BuildGraphQLEnumArray

func BuildGraphQLEnumArray(v interface{}) string

BuildGraphQLEnumArray creates an array for values which can be represented as enums in GraphQL, i.e. do not need to be surrounded by strings.

func MarshalGQL

func MarshalGQL(v interface{}) string

MarshalGQL returns the GraphQL representation of v.

Types

type Client

type Client interface {
	URL() string
	Do(ctx context.Context, req *Request) (*Response, error)
}

Client is a GraphQL endpoint client.

type DefaultClient

type DefaultClient struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(_url string, headers map[string]string) (*DefaultClient, error)

func (*DefaultClient) Do

func (client *DefaultClient) Do(ctx context.Context, req *Request) (*Response, error)

func (*DefaultClient) URL

func (client *DefaultClient) URL() string

type Error

type Error struct {
	Message   string `json:"message"`
	Locations []struct {
		Line   int `json:"line"`
		Column int `json:"column"`
	} `json:"locations"`
}

Error is an error returned from the database for a GraphQL query.

type Marshaller

type Marshaller interface {
	GQL() string
}

Marshaller defines an ability for a type to represent itself in GraphQL.

type Request

type Request struct {
	Query         string                 `json:"query"`
	OperationName string                 `json:"operationName,omitempty"`
	Variables     map[string]interface{} `json:"variables,omitempty"`

	// Response should be a pointer to a struct to deserialize
	// the JSON response into.
	Response interface{} `json:"-"`

	// URL, if different than client URL (e.g. /graphql)
	URL string `json:"-"`
}

Request holds the parameters for a GraphQL query. Query must be included.

func (*Request) Valid

func (req *Request) Valid() error

Valid checks whether the request has required parameters.

type Response

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

Response is the response returned from the database for a GraphQL query.