rest

package

v0.7.0 Latest Latest Go to latest Published: Mar 1, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/valkyrie-fnd/valkyrie

Links

Open Source Insights

Documentation ¶

Overview ¶

Package rest provides convenience and sensible defaults for some low level http client

Index ¶

Variables
func NewHTTPError(code int, msg string) error
type Client
- func Create(config configs.HTTPClientConfig) *Client
type HTTPClientJSONInterface
type HTTPClientXMLInterface
type HTTPError
- func (e HTTPError) Error() string
type HTTPRequest

Constants ¶

This section is empty.

Variables ¶

View Source

var TimeoutError = errors.New("client request timeout")

Functions ¶

func NewHTTPError ¶

func NewHTTPError(code int, msg string) error

Types ¶

type Client ¶

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

func Create ¶

func Create(config configs.HTTPClientConfig) *Client

func (Client) GetJSON ¶

func (c Client) GetJSON(ctx context.Context, req *HTTPRequest, resp any) error

GetJson Issue GET request with expected json response

func (Client) GetXML ¶

func (c Client) GetXML(ctx context.Context, req *HTTPRequest, resp any) error

GetXML Issue GET request with expected XML response

func (Client) PostJSON ¶

func (c Client) PostJSON(ctx context.Context, req *HTTPRequest, resp any) error

PostJson Issue POST request with expected json response

func (Client) PostXML ¶

func (c Client) PostXML(ctx context.Context, req HTTPRequest, resp any) error

PostXML Issue POST request with expected XML response

func (Client) PutJSON ¶

func (c Client) PutJSON(ctx context.Context, req *HTTPRequest, resp any) error

PutJson Issue PUT request with expected json response

func (Client) PutXML ¶

func (c Client) PutXML(ctx context.Context, req *HTTPRequest, resp any) error

PutXML Issue PUT request with expected XML response

type HTTPClientJSONInterface ¶

type HTTPClientJSONInterface interface {
	GetJSON(ctx context.Context, req *HTTPRequest, resp any) error
	PostJSON(ctx context.Context, req *HTTPRequest, resp any) error
	PutJSON(ctx context.Context, req *HTTPRequest, resp any) error
}

HTTPClientJSONInterface interface for client with JSON responses

type HTTPClientXMLInterface ¶

type HTTPClientXMLInterface interface {
	GetXML(ctx context.Context, req *HTTPRequest, resp any) error
	PutXML(ctx context.Context, req *HTTPRequest, resp any) error
	PostXML(ctx context.Context, req *HTTPRequest, resp any) error
}

HTTPClientXMLInterface interface for client with XML responses

type HTTPError ¶

type HTTPError struct {
	Message string
	Code    int
}

HTTPError error returned from Client

func (HTTPError) Error ¶

func (e HTTPError) Error() string

type HTTPRequest ¶

type HTTPRequest struct {
	Body    any
	Headers map[string]string
	Query   map[string]string
	URL     string
}

HTTPRequest represents a http request

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL