hal

Documentation

Index

• func CreateHALLinkList(linkmap map[string][]interface{}, curies []HALCurie) map[string]interface{}
• type EndpointLinker
• type HALCurie
• type HalLink
• type HalWrapper
  • func NewHalWrapper(el EndpointLinker) HalWrapper
  • func (w HalWrapper) MarshalJSON() ([]byte, error)

Functions

func CreateHALLinkList

func CreateHALLinkList(linkmap map[string][]interface{}, curies []HALCurie) map[string]interface{}

Types

type EndpointLinker

type EndpointLinker interface {
	Links() map[string][]interface{}
	Curies() []HALCurie
}

EndpointLinker adds links and curies to an endpoint.

If an entity implements this, HAL data will be added to the response with the HALJSON Render type.

type HALCurie

type HALCurie struct {
	Name      string `json:"name"`
	Href      string `json:"href"`
	Templated bool   `json:"templated"`
}

HALCurie contains documentation information for the endpoint.

type HalLink

type HalLink struct {
	Href string `json:"href"`
}

type HalWrapper

type HalWrapper struct {
	Item  interface{}            `json:"item"`
	Links map[string]interface{} `json:"_links"`
}

func NewHalWrapper

func NewHalWrapper(el EndpointLinker) HalWrapper

func (HalWrapper) MarshalJSON

func (w HalWrapper) MarshalJSON() ([]byte, error)