model

Documentation

Overview

Package model provides common request and response models.

// UserRequest is the request body
type UserRequest struct {
	model.RequestBody	// annotation RequestBody
	Username string		`validate:"required"`
	Password string 	`validate:"required"`
}

Index

• Variables
• type BaseResponse
  • func (r *BaseResponse) GetCode() int
  • func (r *BaseResponse) GetData() interface{}
  • func (r *BaseResponse) GetMessage() string
  • func (r *BaseResponse) SetCode(code int)
  • func (r *BaseResponse) SetData(data interface{})
  • func (r *BaseResponse) SetMessage(message string)
• type RequestBody
• type RequestForm
• type RequestParams
• type Response

Variables

var (
	// RequestTypeBody means it is RequestBody
	RequestTypeBody = "RequestBody"
	// RequestTypeParams means it is RequestParams
	RequestTypeParams = "RequestParams"
	// RequestTypeForm means it is RequestForm
	RequestTypeForm = "RequestForm"
	// Context means it is Context
	Context = "Context"
)

Types

type BaseResponse

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

BaseResponse is the implementation of rest controller's Response

func (*BaseResponse) GetCode

func (r *BaseResponse) GetCode() int

GetCode get error code

func (*BaseResponse) GetData

func (r *BaseResponse) GetData() interface{}

GetData get data

func (*BaseResponse) GetMessage

func (r *BaseResponse) GetMessage() string

GetMessage get message

func (*BaseResponse) SetCode

func (r *BaseResponse) SetCode(code int)

SetCode set error code

func (*BaseResponse) SetData

func (r *BaseResponse) SetData(data interface{})

SetData the data will be serialized to json string

func (*BaseResponse) SetMessage

func (r *BaseResponse) SetMessage(message string)

SetMessage set message

type RequestBody

type RequestBody struct{}

RequestBody the annotation RequestBody

type RequestForm

type RequestForm struct{}

RequestForm the annotation RequestForm

type RequestParams

type RequestParams struct{}

RequestParams the annotation RequestParams

type Response

type Response interface {
	// Set error code
	SetCode(code int)
	// Get error code
	GetCode() int
	// Set message
	SetMessage(message string)
	// Get message
	GetMessage() string
	// Set data, the data will be serialized to json string
	SetData(data interface{})
	// Get data
	GetData() interface{}
}

Response is the interface of rest controller's Response