rest

Documentation

Index

• Variables
• type Endpoint
  • func NewBaseEndpoint(name string) *Endpoint
  • func NewEndpoint(name string, params ...Param) *Endpoint
  • func NewRelativeEndpoint(params ...Param) *Endpoint
  • func (r Endpoint) Path() string
  • func (r Endpoint) String() string
• type Mapper
  • func NewMapper(endpoint *Endpoint, grpcMethod grpc.Method) *Mapper
  • func (m Mapper) Path() string
• type Method
  • func GetMethod(method string) Method
• type Param
  • func NewParam(name string) Param
  • func (r Param) String() string

Variables

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")
	AccountId    = NewParam("account-id")
	OrderId      = NewParam("order-id")
	CartId       = NewParam("cart-id")
	BranchRentId = NewParam("branch-rent-id")
	BranchId     = NewParam("branch-id")
	StoreId      = NewParam("store-id")
	BusinessId   = NewParam("business-id")
	CategoryId   = NewParam("category-id")
	ProductId    = NewParam("product-id")
)

Param values

Types

type Endpoint

type Endpoint struct {
	Name   string
	Params []Param
}

Endpoint is the REST endpoint

func NewBaseEndpoint

func NewBaseEndpoint(name string) *Endpoint

NewBaseEndpoint creates a new base Endpoint

func NewEndpoint

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

NewEndpoint creates a new Endpoint

func NewRelativeEndpoint

func NewRelativeEndpoint(params ...Param) *Endpoint

NewRelativeEndpoint creates a new relative Endpoint

func (Endpoint) Path

func (r Endpoint) Path() string

Path returns the path of the Endpoint

func (Endpoint) String

func (r Endpoint) String() string

String returns the string representation of the Endpoint

type Mapper

type Mapper struct {
	Endpoint   *Endpoint
	GRPCMethod grpc.Method
}

Mapper is the mapper for a REST endpoint and a gRPC method

func NewMapper

func NewMapper(
	endpoint *Endpoint,
	grpcMethod grpc.Method,
) *Mapper

NewMapper creates a new mapper

func (Mapper) Path

func (m Mapper) Path() string

Path returns the path of the REST endpoint

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