client

Documentation

Index

• type Client
  • func NewClient(client *http.Client, baseURL string, options ...HTTPRequestOption) *Client
  • func (c *Client) Post(ctx context.Context, operationName, query string, respData interface{}, ...) error
• type ErrorResponse
  • func (er *ErrorResponse) Error() string
  • func (er *ErrorResponse) HasErrors() bool
• type GqlErrorList
  • func (e *GqlErrorList) Error() string
• type HTTPError
• type HTTPRequestOption
• type Request

Types

type Client

type Client struct {
	Client             *http.Client
	BaseURL            string
	HTTPRequestOptions []HTTPRequestOption
}

Client is the http client wrapper

func NewClient

func NewClient(client *http.Client, baseURL string, options ...HTTPRequestOption) *Client

NewClient creates a new http client wrapper

func (*Client) Post

func (c *Client) Post(ctx context.Context, operationName, query string, respData interface{}, vars map[string]interface{}, httpRequestOptions ...HTTPRequestOption) error

Post sends a http POST request to the graphql endpoint with the given query then unpacks the response into the given object.

type ErrorResponse

type ErrorResponse struct {
	// populated when http status code is not OK
	NetworkError *HTTPError `json:"networkErrors"`
	// populated when http status code is OK but the server returned at least one graphql error
	GqlErrors *gqlerror.List `json:"graphqlErrors"`
}

ErrorResponse represent an handled error

func (*ErrorResponse) Error

func (er *ErrorResponse) Error() string

func (*ErrorResponse) HasErrors

func (er *ErrorResponse) HasErrors() bool

HasErrors returns true when at least one error is declared

type GqlErrorList

type GqlErrorList struct {
	Errors gqlerror.List `json:"errors"`
}

GqlErrorList is the struct of a standard graphql error response

func (*GqlErrorList) Error

func (e *GqlErrorList) Error() string

type HTTPError

type HTTPError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

HTTPError is the error when a GqlErrorList cannot be parsed

type HTTPRequestOption

type HTTPRequestOption func(req *http.Request)

HTTPRequestOption represents the options applicable to the http client

type Request

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

Request represents an outgoing GraphQL request