wrapper

Documentation

Index

• Constants
• func Translate(c echo.Context, res Response) error
• func Wrap(fn EchoHandlerFunc) echo.HandlerFunc
• type EchoHandlerFunc
• type FailResponse
• type Response
• type SuccessResponse

Constants

const (
	DataField    = "data"
	TraceIDField = "trace_id"
	SuccessField = "success"
	// CodeField     = "code"
	MessageField  = "message"
	TotalField    = "total"
	MetadataField = "metadata"
)

Functions

func Translate

func Translate(c echo.Context, res Response) error

Translate response

func Wrap

func Wrap(fn EchoHandlerFunc) echo.HandlerFunc

Types

type EchoHandlerFunc

type EchoHandlerFunc func(c echo.Context) Response

type FailResponse

type FailResponse struct {
	Success bool   `json:"success" example:"false"`
	Message string `json:"message" example:"Example message"`
}

For API docs

type Response

type Response struct {
	Error        error
	Data         interface{}
	Status       int
	Total        int64
	IncludeTotal bool
}

Response body

type SuccessResponse

type SuccessResponse struct {
	Success  bool        `json:"success" example:"true"`
	Data     interface{} `json:"data"`
	Metadata interface{} `json:"metadata"`
}

For API docs