hateoas

README

go-hateoas

A lightweight golang hateoas framework
(not stable - currently under development)

Documentation

Index

• func Handle(apiPath string, rh ResourceHandler) error
• type Error
  • func (e *Error) Error() string
• type Page
• type PageOpts
• type Resource
• type ResourceHandler
• type Url

Functions

func Handle

func Handle(apiPath string, rh ResourceHandler) error

Types

type Error

type Error struct {
	Status           int    `json:"status"`
	Code             int    `json:"code"`
	Property         string `json:"property,omitempty"`
	Message          string `json:"message"`
	DeveloperMessage string `json:"developerMessage"`
	MoreInfo         string `json:"moreInfo,omitempty"`
}

This is a returned type Error type for REST hateoas

func (*Error) Error

func (e *Error) Error() string

type Page

type Page struct {
	Href     Url
	Offset   int
	Limit    int
	First    *Url
	Previous *Url
	Next     *Url
	Last     *Url
	Items    []hateoasResource

	TotalItems int
}

This is a returned type Page type for REST hateoas

type PageOpts

type PageOpts struct {
	Offset int
	Limit  int
}

PageOpts type for page options extracted from the GET parameters

type Resource

type Resource interface {
	GetId() string
}

Abstract interface for a REST resource

type ResourceHandler

type ResourceHandler interface {
	ResourceName() string

	GetOne(string) (Resource, *Error)
	GetAll(PageOpts) ([]Resource, *Error)
	Create(Resource) (string, *Error)
	Update(string, Resource) (Resource, *Error)
	Delete(string) *Error

	Count() (int, *Error)
}

Abstract interface for a REST resource handler

type Url

type Url string

URL type for representing HREF links