response

Documentation

Index

• Variables
• func AddErrorHandlingMiddleware() gin.HandlerFunc
• func EncodeJSON(_ context.Context, w http.ResponseWriter, response interface{}) error
• type Response
  • func (resp *Response) String() string
  • func (resp *Response) WithData(data any) *Response
  • func (resp *Response) WithMessage(message string) *Response
  • func (resp *Response) WrapError(err error) *Response

Variables

var (
	// OK request is successful.
	OK = &Response{Code: http.StatusOK, Message: "ok"}

	// Err request is failed.
	Err = &Response{Code: http.StatusInternalServerError, Message: "unknown error"}
)

Functions

func AddErrorHandlingMiddleware

func AddErrorHandlingMiddleware() gin.HandlerFunc

AddErrorHandlingMiddleware is used to add error handling middleware.

func EncodeJSON

func EncodeJSON(_ context.Context, w http.ResponseWriter, response interface{}) error

EncodeJSON encode response to json.

Types

type Response

type Response struct {
	Code    int         `json:"code,omitempty"`
	Message string      `json:"msg,omitempty"`
	Data    interface{} `json:"data,omitempty"`
}

Response response struct.

func (*Response) String

func (resp *Response) String() string

func (*Response) WithData

func (resp *Response) WithData(data any) *Response

WithData set response data.

func (*Response) WithMessage

func (resp *Response) WithMessage(message string) *Response

WithMessage set response message.

func (*Response) WrapError

func (resp *Response) WrapError(err error) *Response

WrapError wrap error to response.