graphql

README

graphql

Simple GraphQL client for executing mutations and queries.

Copyright 2020, 2021, Ardan Labs
info@ardanlabs.com

Licensing

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About The Project

Package graphql provides support for executing mutations and queries against a database using GraphQL. It was designed specifically for working with Dgraph.

All of the documentation can be found on the go.dev website.

Documentation

Overview

Package graphql provides client support for executing graphql requests against a host that supports the graphql protocol.

Index

• func WithClient(client *http.Client) func(gql *GraphQL)
• func WithHeader(key string, value string) func(gql *GraphQL)
• func WithLogging(logFunc func(s string)) func(gql *GraphQL)
• func WithVariable(key string, value interface{}) func(m map[string]interface{})
• type GraphQL
  • func New(url string, options ...func(gql *GraphQL)) *GraphQL
  • func (g *GraphQL) Execute(ctx context.Context, graphql string, response interface{}, ...) error
  • func (g *GraphQL) ExecuteOnEndpoint(ctx context.Context, endpoint string, graphql string, response interface{}, ...) error
  • func (g *GraphQL) RawRequest(ctx context.Context, endpoint string, r io.Reader, response interface{}) error

Functions

func WithClient

func WithClient(client *http.Client) func(gql *GraphQL)

WithClient adds a custom client for processing requests. It's recommend to not use the default client and provide your own.

func WithHeader

func WithHeader(key string, value string) func(gql *GraphQL)

WithHeader adds a key/value pair to the request header for all calls made to the host. This is for things like authentication or application specific needs. These headers are already included: "Cache-Control": "no-cache", "Content-Type": "application/json", "Accept": "application/json"

func WithLogging

func WithLogging(logFunc func(s string)) func(gql *GraphQL)

WithLogging acceps a function for capturing raw execution messages for the purpose of application logging.

func WithVariable

func WithVariable(key string, value interface{}) func(m map[string]interface{})

WithVariable allows for the submission of variables when executing graphql against the host for queries that supports variable substitution.

Types

type GraphQL

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

GraphQL represents a client that can execute graphql and raw requests against a host.

func New

func New(url string, options ...func(gql *GraphQL)) *GraphQL

New constructs a GraphQL that can be used to execute graphql and raw requests against the specified url. The url represents a fully qualified URL without the `graphql` endpoint attached. If `/graphql` is provided, it's trimmed off.

func (*GraphQL) Execute

func (g *GraphQL) Execute(ctx context.Context, graphql string, response interface{}, variables ...func(m map[string]interface{})) error

Execute performs a graphql request against the configured host on the url/graphql endpoint.

func (*GraphQL) ExecuteOnEndpoint

func (g *GraphQL) ExecuteOnEndpoint(ctx context.Context, endpoint string, graphql string, response interface{}, variables ...func(m map[string]interface{})) error

ExecuteOnEndpoint performs a graphql request against the configured host on the specified url/endpoint

func (*GraphQL) RawRequest

func (g *GraphQL) RawRequest(ctx context.Context, endpoint string, r io.Reader, response interface{}) error

RawRequest performs the actual execution of a request against the specified url/endpoint. Use this function only when the request doesn't require a graphql document wrapper.