Documentation
¶
Index ¶
Constants ¶
const StandardPagingOptions = "{?cursor,limit,order}"
StandardPagingOptions is a helper string to make creating paged collection URIs simpler.
Variables ¶
This section is empty.
Functions ¶
func ExecuteFunc ¶
func Render ¶
func Render(w http.ResponseWriter, data interface{})
Render write data to w, after marshaling to json
Types ¶
type BasePage ¶
type BasePage struct {
FullURL *url.URL `json:"-"`
Embedded struct {
Records []Pageable `json:"records"`
} `json:"_embedded"`
}
BasePage represents the simplest page: one with no links and only embedded records. Can be used to build custom page-like resources
type Link ¶
func (*Link) PopulateTemplated ¶
func (l *Link) PopulateTemplated()
type LinkBuilder ¶
LinkBuilder is a helper for constructing URLs in horizon.
func (*LinkBuilder) Link ¶
func (lb *LinkBuilder) Link(parts ...string) Link
Link returns a hal.Link whose href is each of the provided parts joined by '/'
func (*LinkBuilder) Linkf ¶
func (lb *LinkBuilder) Linkf(format string, args ...interface{}) Link
Linkf provides a helper function that returns a link with an href created by passing the arguments into fmt.Sprintf
func (*LinkBuilder) PagedLink ¶
func (lb *LinkBuilder) PagedLink(parts ...string) Link
PagedLink creates a link using the `Link` method and appends the common paging options
type Page ¶
type Page struct {
Links Links `json:"_links"`
BasePage
Order string `json:"-"`
Limit uint64 `json:"-"`
Cursor string `json:"-"`
}
Page represents the common page configuration (i.e. has self, next, and prev links) and has a helper method `PopulateLinks` to automate their initialization.
func (*Page) InvertedOrder ¶
InvertedOrder returns the inversion of the page's current order. Used to populate the prev link
func (*Page) PopulateLinks ¶
func (p *Page) PopulateLinks()
PopulateLinks sets the common links for a page.
Source Files