handler

package

v1.3.7 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func LogErrorStacktrace(err error)

type App interface {
	HandleRequest(requests requests.Request) (interface{}, error)
}

type BaseHandler struct {
	App App
}

BaseHandler is a struct with basic methods that should be extended to properly handle a HTTP Service.

func NewHandler(App App) *BaseHandler

func (h *BaseHandler) BindedRequest(c echo.Context, op string, request requests.Request, body requests.Body) error

func (h *BaseHandler) BindedRequestXMLResponse(c echo.Context, op string, request requests.Request, body requests.Body) error

func (h *BaseHandler) GetListLimit(c echo.Context, defaultLimit int) int

func (h *BaseHandler) GetListOffest(c echo.Context, defaultOffset int) int

func (h *BaseHandler) GetNumericQueryParam(c echo.Context, param string, defaultValue int) int

func (h *BaseHandler) GetParameterID(c echo.Context, name string) (int64, error)

func (h *BaseHandler) GetParameterString(c echo.Context, name string) (string, error)

func (h *BaseHandler) GetQueryID(c echo.Context, value string) (int64, error)

func (h *BaseHandler) GetQueryParamsInt64(c echo.Context, key string) ([]int64, error)

func (h *BaseHandler) ManageError(c echo.Context, op string, request requests.Request, err error) error

ManageError translates an error into the appropriate HTTP error code

func (h *BaseHandler) StandardRequest(c echo.Context, op string, request requests.Request, body requests.Body) error

type ErrorResponse struct {
	Error StandardError `json:"error"`
}

ErrorResponse defines the structure of the error that the handler will return

type StandardError struct {
	Code      string `json:"code"`
	Message   string `json:"message"`
	RequestID string `json:"request_id"`
}

StandardError defines a error in JSON format