base_response

Documentation

Index

• Variables
• type PageRequest
  • func (w *PageRequest) Validate() (err error)
• type PageResponse
  • func NewDataPageResponse(data interface{}, currentPage, pageSize uint, total uint64) *PageResponse
  • func NewErrorPageResponse(err error, retCode *RetCode, currentPage, pageSize uint, total uint64) *PageResponse
  • func NewPageResponse(currentPage, pageSize uint, total uint64) *PageResponse
• type Response
  • func NewDataResponse(data interface{}) *Response
  • func NewErrorResponse(err error, retcode *RetCode) *Response
  • func NewResponse() *Response
• type RetCode
  • func NewRetCode(code int, message string) *RetCode

Variables

var (
	SUCCESS        = NewRetCode(0, "Success")
	UnknownError   = NewRetCode(10000, "Unknown error")
	Unauthorized   = NewRetCode(10001, "Unauthorized")
	WrongParams    = NewRetCode(10002, "Wrong params")
	BindDataFailed = NewRetCode(10003, "Bind data failed")
	Forbidden      = NewRetCode(10004, "Forbidden")
)

Types

type PageRequest

type PageRequest struct {
	PageSize    uint `form:"pageSize"`
	CurrentPage uint `form:"current"`
}

func (*PageRequest) Validate

func (w *PageRequest) Validate() (err error)

type PageResponse

type PageResponse struct {
	Code        int         `json:"code"`
	Message     string      `json:"message"`
	Error       string      `json:"error"`
	Data        interface{} `json:"data"`
	CurrentPage uint        `json:"current"`
	PageSize    uint        `json:"pageSize"`
	Total       uint64      `json:"total"`
}

func NewDataPageResponse

func NewDataPageResponse(data interface{}, currentPage, pageSize uint, total uint64) *PageResponse

func NewErrorPageResponse

func NewErrorPageResponse(err error, retCode *RetCode, currentPage, pageSize uint, total uint64) *PageResponse

func NewPageResponse

func NewPageResponse(currentPage, pageSize uint, total uint64) *PageResponse

type Response

type Response struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Error   string      `json:"error"`
	Data    interface{} `json:"data"`
}

func NewDataResponse

func NewDataResponse(data interface{}) *Response

func NewErrorResponse

func NewErrorResponse(err error, retcode *RetCode) *Response

func NewResponse

func NewResponse() *Response

type RetCode

type RetCode struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

func NewRetCode

func NewRetCode(code int, message string) *RetCode