response

Documentation

Index

• Variables
• type DefaultHandler
  • func NewDefaultHandler(mode *goflagsmode.Flag) (*DefaultHandler, error)
  • func (d *DefaultHandler) HandleErrorResponse(ctx *gin.Context, errorCode int, err error)
  • func (d *DefaultHandler) HandleResponse(ctx *gin.Context, successCode int, response interface{}, errorCode int, ...)
• type ErrorResponse
  • func NewErrorResponse(err error) ErrorResponse
• type Handler

Variables

var (
	ErrNilHandler = errors.New("response handler cannot be nil")
)

Types

type DefaultHandler

type DefaultHandler struct {
	// contains filtered or unexported fields
}

DefaultHandler struct

func NewDefaultHandler

func NewDefaultHandler(mode *goflagsmode.Flag) (*DefaultHandler, error)

NewDefaultHandler creates a new default request handler

func (*DefaultHandler) HandleErrorResponse

func (d *DefaultHandler) HandleErrorResponse(
	ctx *gin.Context,
	errorCode int,
	err error,
)

HandleErrorResponse handles the error response

func (*DefaultHandler) HandleResponse

func (d *DefaultHandler) HandleResponse(
	ctx *gin.Context,
	successCode int,
	response interface{},
	errorCode int,
	err error,
)

HandleResponse handles the response

type ErrorResponse

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

ErrorResponse struct

func NewErrorResponse

func NewErrorResponse(err error) ErrorResponse

NewErrorResponse creates a new error response

type Handler

type Handler interface {
	HandleResponse(
		ctx *gin.Context,
		successCode int,
		response interface{},
		errorCode int,
		err error,
	)
	HandleErrorResponse(ctx *gin.Context, errorCode error, err error)
}

Handler interface for handling the responses