com_model

Documentation

Index

• Variables
• type CommonReturn
  • func NewFailure(code errs.ErrCode, msg string) *CommonReturn
  • func NewRet(err *errs.Err) *CommonReturn
  • func NewRetFromErr(err error) *CommonReturn
  • func NewSuccess(data interface{}) *CommonReturn
• type Model
  • func NewModel() Model
• type ModelVo
• type PageData
  • func NewPageData(pageNum, pageSize, totalCount int64, data interface{}) *PageData
  • func NewPageData2(pageInfo *PageInfo, data interface{}) *PageData
• type PageInfo
  • func NewPageInfo(pageNum, pageSize, totalCount int64) *PageInfo
• type PageParams
  • func NewPageParams() *PageParams
  • func (p *PageParams) CheckOkOrSetDefault()
  • func (p *PageParams) Limit() int64
  • func (p *PageParams) OffSet() int64
• type SingleId

Variables

var StdSuccess = &CommonReturn{
	Code:    errs.Success.ToInt(),
	Message: "success",
	Detail:  nil,
	Data:    nil,
}

Types

type CommonReturn

type CommonReturn struct {
	Code    int     `json:"code" swaggo:"true,错误码" example:"400"`
	Message string  `json:"message" swaggo:"true,错误信息" example:"错误信息"`
	Detail  *string `` // 可由运行模式控制是否显示
	/* 135-byte string literal not displayed */
	Data interface{} `json:"data,omitempty" ` // 数据值
}

CommonReturn

func NewFailure

func NewFailure(code errs.ErrCode, msg string) *CommonReturn

func NewRet

func NewRet(err *errs.Err) *CommonReturn

func NewRetFromErr

func NewRetFromErr(err error) *CommonReturn

func NewSuccess

func NewSuccess(data interface{}) *CommonReturn

type Model

type Model struct {
	Id        string         `gorm:"column:id;primaryKey;type:char(36)" json:"id"`
	CreatedAt time.Time      `json:"created_at" gorm:"column:created_at;not null;type:datetime(3);default:CURRENT_TIMESTAMP(3)"`
	UpdatedAt time.Time      `json:"updated_at" gorm:"column:updated_at;not null;type:datetime(3);default:CURRENT_TIMESTAMP(3)"`
	DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;index;type:datetime(3)" json:"deleted_at"`
}

func NewModel

func NewModel() Model

type ModelVo

type ModelVo struct {
	Id        string     `gorm:"column:id;primaryKey;type:char(36)" json:"id"`
	CreatedAt time.Time  `json:"created_at" gorm:"column:created_at;not null;type:datetime(3);default:CURRENT_TIMESTAMP(3)"`
	UpdatedAt time.Time  `json:"updated_at" gorm:"column:updated_at;not null;type:datetime(3);default:CURRENT_TIMESTAMP(3)"`
	DeletedAt *time.Time `gorm:"column:deleted_at;index;type:datetime(3)" json:"deleted_at"`
}

type PageData

type PageData struct {
	PageInfo PageInfo    `json:"page_info"` // 分页信息
	Data     interface{} `json:"data"`      // 列表数据
}

func NewPageData

func NewPageData(pageNum, pageSize, totalCount int64, data interface{}) *PageData

func NewPageData2

func NewPageData2(pageInfo *PageInfo, data interface{}) *PageData

type PageInfo

type PageInfo struct {
	TotalCount int64 `json:"total_count" swaggo:"true,总条数"` // 总数据条数
	TotalPage  int64 `json:"total_page" swaggo:"true,所有页数"`
	PageNum    int64 `json:"page_num" swaggo:"true,当前页码"`
	PageSize   int64 `json:"page_size" swggo:"true,页大小"`
}

PaginationResult 分页查询结果

func NewPageInfo

func NewPageInfo(pageNum, pageSize, totalCount int64) *PageInfo

type PageParams

type PageParams struct {
	PageNum  int64 `form:"page_num" json:"page_num" xml:"page_num"  binding:"required"`    // 页索引
	PageSize int64 `form:"page_size" json:"page_size" xml:"page_size"  binding:"required"` // 页大小
}

PaginationParam 分页查询条件 @Param page_num query int true "page_num页索引" @Param page_size query int true "page_size页大小"

func NewPageParams

func NewPageParams() *PageParams

func (*PageParams) CheckOkOrSetDefault

func (p *PageParams) CheckOkOrSetDefault()

func (*PageParams) Limit

func (p *PageParams) Limit() int64

func (*PageParams) OffSet

func (p *PageParams) OffSet() int64

type SingleId

type SingleId struct {
	Id string `json:"id"`
}