hypermedia

type CachedResource ¶

type CachedResource interface {
	Rels() (Relations, bool)
	CacheRels(Relations)
}

A CachedResource is capable of caching the relations locally, so that multiple accesses don't require parsing it again.

type HALResource ¶

type HALResource struct {
	Links Links `json:"_links"`
	// contains filtered or unexported fields
}

HALResource is a resource with hypermedia specified as JSON HAL.

http://stateless.co/hal_specification.html

func (r *HALResource) HypermediaRels(rels Relations)

type HyperfieldResource ¶

type HyperfieldResource interface {
	HyperfieldRels()
}

type Hyperlink ¶

type Hyperlink string

Hyperlink is a string url. If it is a uri template, it can be converted to a full URL with Expand().

func (l Hyperlink) Expand(m M) (*url.URL, error)

type HypermediaResource ¶

type HypermediaResource interface {
	HypermediaRels(Relations)
}

A HypermediaResource has link relations for next actions of a resource.

type Link ¶

type Link struct {
	Href Hyperlink `json:"href"`
}

Link represents a single link in a HALResource.

func (l *Link) Expand(m M) (*url.URL, error)

type Links ¶

type Links map[string]Link

Links is a collection of Link objects in a HALResource. Note that the HAL spec allows single link objects or an array of link objects. Sawyer currently only supports single link objects.

type M ¶

type M map[string]interface{}

M represents a map of values to expand a Hyperlink.

type Relations ¶

type Relations map[string]Hyperlink

Relations is a map of keys that point to Hyperlink objects.

func HyperFieldRelations(res interface{}, rels Relations) Relations

type Foo struct {
  Url         Hyperlink `rel:"self" json:"url"`
  CommentsUrl Hyperlink `rel:"comments" json:"comments_url"`
}

func HyperHeaderRelations(header http.Header, rels Relations) Relations

func NewRels() Relations

func Rels(resource interface{}) Relations

func (h Relations) Rel(name string, m M) (*url.URL, error)