README
¶
hateoas
import "github.com/CreatorKit/go-deviceserver-client/hateoas"
Overview
Generic-ish HATEOAS client for golang
Index
- Variables
- type Client
- func Create(config *Client) *Client
- func (c *Client) Delete(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
- func (c *Client) Do(method string, url string, navigateLinks Navigate, headers Headers, body io.Reader, result interface{}) (*http.Response, error)
- func (c *Client) Get(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
- func (c *Client) Post(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
- func (c *Client) PostForm(url string, navigateLinks Navigate, headers Headers, data url.Values, response interface{}) (*http.Response, error)
- type HTTPDoer
- type Headers
- type Link
- type Links
- type Navigate
- type SimpleEndpoint
Package files
Variables
var (
ErrorLinkNotFound = errors.New("Link not found")
ErrorHttpStatus = errors.New("HTTP status error")
ErrorBadConfig = errors.New("bad config")
)
type Client
type Client struct {
EntryURL string
DefaultHeaders Headers
Http HTTPDoer
}
Client is the main object for executing requests
func Create
func Create(config *Client) *Client
Create will populate some defaults into a provided Client structure
func (*Client) Delete
func (c *Client) Delete(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
Delete is a small wrapper around Do
func (*Client) Do
func (c *Client) Do(method string, url string, navigateLinks Navigate, headers Headers, body io.Reader, result interface{}) (*http.Response, error)
Do will start at the provided URL (or default to Client.EntryURL) and traverse the links specified by navigateLinks (with GET)
before finally issuing method to the resultant URL
func (*Client) Get
func (c *Client) Get(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
Get is a small wrapper around Do
func (*Client) Post
func (c *Client) Post(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
Post is a small wrapper around Do
func (*Client) PostForm
func (c *Client) PostForm(url string, navigateLinks Navigate, headers Headers, data url.Values, response interface{}) (*http.Response, error)
PostForm is a small wrapper around Do
type HTTPDoer
type HTTPDoer interface {
Do(*http.Request) (*http.Response, error)
}
HTTPDoer would normally be an instance of *http.Client but by making it an interface we allow wrapping to permit logging or caching etc
type Headers
type Headers map[string]string
Headers is the HTTP headers to be added to a request
type Link
type Link struct {
Rel string `json:"rel"`
Href string `json:"href"`
Type string `json:"type"`
}
Link is the main HATEOAS link object
type Links
type Links []Link
Links is just an array of Link, but with some helper methods
func (Links) Get
func (l Links) Get(rel string) (*Link, error)
Get returns the link matching the specified rel name
func (Links) Self
func (l Links) Self() string
Self is a small wrapper around Get, mostly useful when you don't need to worry if the link isn't actually there (e.g. when printing debug stuff to a CLI output)
type Navigate
type Navigate []string
Navigate specifies a list of links to be traversed
type SimpleEndpoint
type SimpleEndpoint struct {
Links Links `json:"Links"`
}
SimpleEndpoint is used when navigating links on endpoints
Generated by godoc12md
Documentation
¶
Overview ¶
Generic-ish HATEOAS client for golang
Index ¶
- Variables
- type Client
- func (c *Client) Delete(url string, navigateLinks Navigate, headers Headers, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Do(method string, url string, navigateLinks Navigate, headers Headers, ...) (*http.Response, error)
- func (c *Client) Get(url string, navigateLinks Navigate, headers Headers, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Post(url string, navigateLinks Navigate, headers Headers, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostForm(url string, navigateLinks Navigate, headers Headers, data url.Values, ...) (*http.Response, error)
- type HTTPDoer
- type Headers
- type Link
- type Links
- type Navigate
- type SimpleEndpoint
Constants ¶
This section is empty.
Variables ¶
var ( ErrorLinkNotFound = "Link not found" ErrorHttpStatus = "HTTP status error" ErrorBadConfig = "bad config" )
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client is the main object for executing requests
func (*Client) Delete ¶
func (c *Client) Delete(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
Delete is a small wrapper around Do
func (*Client) Do ¶
func (c *Client) Do(method string, url string, navigateLinks Navigate, headers Headers, body io.Reader, result interface{}) (*http.Response, error)
Do will start at the provided URL (or default to `Client.EntryURL`) and traverse the links specified by `navigateLinks` (with GET) before finally issuing `method` to the resultant URL
func (*Client) Get ¶
func (c *Client) Get(url string, navigateLinks Navigate, headers Headers, body io.Reader, response interface{}) (*http.Response, error)
Get is a small wrapper around Do
type HTTPDoer ¶
HTTPDoer would normally be an instance of *http.Client but by making it an interface we allow wrapping to permit logging or caching etc
type Links ¶
type Links []Link
Links is just an array of Link, but with some helper methods
type SimpleEndpoint ¶
type SimpleEndpoint struct {
Links Links `json:"Links"`
}
SimpleEndpoint is used when navigating links on endpoints
Source Files