rest

Documentation

Index

• Constants
• func GenerateURI(ctx *aah.Context, routeName string, args ...interface{}) string
• type Embedded
• type Hateoas
• type Hateoasable
• type Link
• type Links

Constants

const (
	LinkSelf     = "self"
	LinkFirst    = "first"
	LinkLast     = "last"
	LinkPrevious = "previous"
	LinkNext     = "next"

	// QueryPage is query param use for the pagination
	QueryPage = "_page"
)

List of available links for collection

Functions

func GenerateURI

func GenerateURI(ctx *aah.Context, routeName string, args ...interface{}) string

GenerateURI return uri for one given route

Types

type Embedded

type Embedded map[string]interface{}

Embedded struct in hateoas response

type Hateoas

type Hateoas struct {
	Embedded Embedded `json:"_embedded,omitempty" gorm:"-"`
	Links    Links    `json:"_links,omitempty"    gorm:"-"`
}

Hateoas struct with all necessary component for hateoas response

type Hateoasable

type Hateoasable interface {
	GenerateHateoas(ctx *aah.Context) error
}

Hateoasable interface for generate hateoas content

type Link

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

Link to another resource

type Links

type Links map[string]Link

Links to another resources