rest

Documentation

Index

• Variables
• type Endpoint
  • func NewEndpoint(name string, params ...Param) *Endpoint
  • func (r Endpoint) String() string
• type Map
  • func NewMap(interceptions *map[string]map[Method]grpc.Method, ...) *Map
  • func (m *Map) Traverse(relativeURI string, restMethod Method) (*grpc.Method, error)
• type Mapper
• type Method
  • func GetMethod(method string) Method
• type Param
  • func NewParam(name string) Param
  • func (r Param) String() string

Variables

var (
	MissingInterceptions        = errors.New("missing interceptions")
	MissingEndpointInterception = errors.New("missing endpoint interception")
	MissingChildrenMap          = errors.New("missing children map")
	FailedToTraverse            = errors.New("failed to traverse")
)

var (
	Email        = NewParam("email")
	Username     = NewParam("username")
	Token        = NewParam("token")
	Id           = NewParam("id")
	PermissionId = NewParam("permission-id")
	RoleId       = NewParam("role-id")
	UserId       = NewParam("user-id")
	JwtId        = NewParam("jwt-id")
)

Param values

Types

type Endpoint

type Endpoint struct {
	Name   string
	Params []Param
}

Endpoint is the REST endpoint

func NewEndpoint

func NewEndpoint(name string, params ...Param) *Endpoint

NewEndpoint creates a new Endpoint

func (Endpoint) String

func (r Endpoint) String() string

String returns the string representation of the Endpoint

type Map

type Map struct {
	Interceptions *map[string]map[Method]grpc.Method
	ChildrenMaps  *map[string]*Map
}

Map struct for the REST endpoints

func NewMap

func NewMap(interceptions *map[string]map[Method]grpc.Method, childrenMaps *map[string]*Map) *Map

NewMap creates a new REST map

func (*Map) Traverse

func (m *Map) Traverse(relativeURI string, restMethod Method) (*grpc.Method, error)

Traverse traverses the REST map

type Mapper

type Mapper interface {
	Traverse(relativeURI string, restMethod Method) (*grpc.Method, error)
}

Mapper is the interface for the REST map

type Method

type Method int

Method is the type of REST request method

const (
	GET Method = iota
	POST
	PUT
	PATCH
	DELETE
	INVALID
)

Method values

func GetMethod

func GetMethod(method string) Method

GetMethod returns the Method from the string

type Param

type Param struct {
	Name string
}

Param is the type of REST request parameter

func NewParam

func NewParam(name string) Param

NewParam creates a new Param

func (Param) String

func (r Param) String() string

String returns the string representation of the Param