response

Documentation

Index

• Variables
• func AddErrorHandlingMiddleware() gin.HandlerFunc
• type Response
  • func (resp *Response) WithData(data any) *Response
  • func (resp *Response) WithMessage(message string) *Response

Variables

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

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

Functions

func AddErrorHandlingMiddleware

func AddErrorHandlingMiddleware() gin.HandlerFunc

AddErrorHandlingMiddleware is used to add error handling middleware.

Types

type Response

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

Response defines the response struct.

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.