gogql

README

gogql - Go GraphQL things

Copyright (c) 2020, 2024, Geert JM Vanderkelen

The gogql package contains various tooling around GraphQL.

License

Distributed under the MIT license. See LICENSE.md for more information.

Documentation

Index

• func GQLGenInputObjectFields(ctx context.Context, arguments ...string) (map[string][]string, error)
• func ProvidedFieldsForCurrentMutation(ctx context.Context, filterArguments ...string) (map[string][]string, error)
• type Client
  • func NewClient(apiEndpoint string) *Client
  • func (c *Client) Execute(query string, result any) []error
  • func (c *Client) ExecuteWithVars(query string, result interface{}, vars map[string]any) []error
  • func (c *Client) SetHeader(key, value string)
• type Payload
• type Result

Functions

func GQLGenInputObjectFields

func GQLGenInputObjectFields(ctx context.Context, arguments ...string) (map[string][]string, error)

GQLGenInputObjectFields retrieves the fields of the Input Object types used as arguments when executing mutations.

Deprecated: use ProvidedFieldsForCurrentMutation instead.

func ProvidedFieldsForCurrentMutation

func ProvidedFieldsForCurrentMutation(ctx context.Context, filterArguments ...string) (map[string][]string, error)

ProvidedFieldsForCurrentMutation retrieves the fields of the Input Object types used as arguments within a gqlgen generated resolver.

For example, `mutation { updateUser(input: {id: 123, name: "Marta"}) { id }` would return the fields "id" and "name" returning a map with key 'input', and slice of strings. If no arguments are specified, 'input' will be returned (if available). This also works when variables are used.

This function is intended to be used in gqlgen generated resolvers handling mutations.

Types

type Client

type Client struct {
	ContentType string
	HttpClient  *http.Client
	// contains filtered or unexported fields
}

Client defines a GraphQL client connecting to the endpoint using HTTP.

func NewClient

func NewClient(apiEndpoint string) *Client

NewClient returns a new GraphQL Client connecting to the apiEndpoint.

func (*Client) Execute

func (c *Client) Execute(query string, result any) []error

Execute executes the GraphQL query.

func (*Client) ExecuteWithVars

func (c *Client) ExecuteWithVars(query string, result interface{}, vars map[string]any) []error

func (*Client) SetHeader

func (c *Client) SetHeader(key, value string)

type Payload

type Payload struct {
	Query     string         `json:"query"`
	Variables map[string]any `json:"variables,omitempty"`
}

Payload defines what we send to the GraphQL endpoint.

type Result

type Result struct {
	Data   json.RawMessage  `json:"data,omitempty"`
	Errors []gqlerror.Error `json:"errors,omitempty"`
}