service

Documentation

Index

• func ParseBody(data []byte, destination interface{}) error
• type Collection
• type Config
• type ContentResponse
  • func ToContentResponse(resources interface{}, meta ContentResponseMeta) ContentResponse
• type ContentResponseContext
• type ContentResponseMeta
• type ContextTPL
• type Kind
• type Message
• type MessageTPL
• type Messages
• type ParamHolder
• type ParamItem
  • func (p ParamItem) AsInt() int
  • func (p ParamItem) SetValue(value string)
  • func (p *ParamItem) SetValues(values []string)
• type PrivateTPL
• type RawBody
• type RawHeaders
  • func (ps RawHeaders) Assign(v interface{}) error
  • func (ps RawHeaders) Get(name string) (ParamItem, bool)
• type RawParams
  • func (ps RawParams) AsMap() map[string]string
  • func (ps RawParams) Assign(v interface{}) error
  • func (ps RawParams) Get(name string) (ParamItem, bool)
  • func (ps RawParams) GetWithFallback(name string, fallback string) ParamItem
  • func (ps RawParams) ValuesMap() map[string][]string
• type Reason
• type Req
• type ResultError
  • func Error(status int, err error, reasons ...Reason) *ResultError
  • func ToResultError(err error, message string, status int) *ResultError
  • func (m *ResultError) Error() string
  • func (m *ResultError) GetDetails() ResultError
  • func (m *ResultError) GetMessage() string
  • func (m *ResultError) GetStatus() int
• type StreamResult
• type TPL

Functions

func ParseBody

func ParseBody(data []byte, destination interface{}) error

Types

type Collection

type Collection []Config

type Config

type Config struct {
	Kind          Kind
	IsStream      bool
	IsPrivate     bool
	Key           string
	Path          string
	Method        string
	Build         func(meta.RequestId, RawHeaders, RawBody, RawParams) (TPL, error)
	BuildMessages func(meta.RequestId, RawHeaders, RawBody, RawParams) (MessageTPL, error)
	Direct        func(req Req) (interface{}, error)
	Auth          func(Req) error
	Before        []func(Config, Req) error
	After         func(Config, Req)
}

type ContentResponse

type ContentResponse struct {
	Content interface{} `json:"content"`
	ContentResponseContext
	ContentResponseMeta
}

func ToContentResponse

func ToContentResponse(
	resources interface{},
	meta ContentResponseMeta,
) ContentResponse

type ContentResponseContext

type ContentResponseContext struct {
	First      bool `json:"first"`
	Last       bool `json:"last"`
	TotalPages int  `json:"total_pages"`
}

type ContentResponseMeta

type ContentResponseMeta struct {
	Size  int   `json:"size"`
	Total int   `json:"total"`
	Page  int   `json:"current_page"`
	Error error `json:"error,omitempty"`
}

type ContextTPL

type ContextTPL interface {
	Result(Req) (interface{}, error)
}

type Kind

type Kind int

const (
	DEFAULT Kind = iota // 0
	DIRECT              // 1, and so on.
)

type Message

type Message struct {
	Key   string
	Value interface{}
}

type MessageTPL

type MessageTPL interface {
	Result() (Messages, error)
}

type Messages

type Messages []Message

type ParamHolder

type ParamHolder interface {
	Get(string) (ParamItem, bool)
}

type ParamItem

type ParamItem struct {
	Key    string
	Value  string
	Values []string
}

func (ParamItem) AsInt

func (p ParamItem) AsInt() int

func (ParamItem) SetValue

func (p ParamItem) SetValue(value string)

func (*ParamItem) SetValues

func (p *ParamItem) SetValues(values []string)

type PrivateTPL

type PrivateTPL interface {
	Auth(meta.RequestId, RawHeaders, RawBody, RawParams) error
	TPL
}

type RawBody

type RawBody []byte

type RawHeaders

type RawHeaders []ParamItem

func (RawHeaders) Assign

func (ps RawHeaders) Assign(v interface{}) error

func (RawHeaders) Get

func (ps RawHeaders) Get(name string) (ParamItem, bool)

type RawParams

type RawParams []ParamItem

func (RawParams) AsMap

func (ps RawParams) AsMap() map[string]string

func (RawParams) Assign

func (ps RawParams) Assign(v interface{}) error

func (RawParams) Get

func (ps RawParams) Get(name string) (ParamItem, bool)

func (RawParams) GetWithFallback

func (ps RawParams) GetWithFallback(name string, fallback string) ParamItem

func (RawParams) ValuesMap

func (ps RawParams) ValuesMap() map[string][]string

type Reason

type Reason map[string]interface{}

type Req

type Req struct {
	ID      meta.RequestId
	Headers RawHeaders
	Body    RawBody
	Params  RawParams
	Timer   *servertiming.Header
	Context *gin.Context
}

type ResultError

type ResultError struct {
	Status     int                      `json:"-"`
	Field      string                   `json:"-"`
	ErrMessage string                   `json:"-"`
	Message    string                   `json:"message"`
	Reasons    []map[string]interface{} `json:"reasons"`
}

func Error

func Error(
	status int,
	err error,
	reasons ...Reason,
) *ResultError

func ToResultError

func ToResultError(err error, message string, status int) *ResultError

func (*ResultError) Error

func (m *ResultError) Error() string

func (*ResultError) GetDetails

func (m *ResultError) GetDetails() ResultError

func (*ResultError) GetMessage

func (m *ResultError) GetMessage() string

func (*ResultError) GetStatus

func (m *ResultError) GetStatus() int

type StreamResult

type StreamResult struct {
	Type   string
	Length string
	Writer func(io.Writer) bool
}

type TPL

type TPL interface {
	Result() (interface{}, error)
}