rest

README

rest

包含一些基本的 REST 结构

Documentation

Index

• type BaseDTO
• type BaseGetter
• type BaseVO
  • func (inst *BaseVO) GetBase() *BaseVO
• type ExampleDTO
• type ExampleVO
• type Pagination
  • func (inst *Pagination) Limit() int
  • func (inst *Pagination) Offset() int64
• type UserID
  • func ParseUserID(s string) (UserID, error)
  • func (id UserID) String() string

Types

type BaseDTO

type BaseDTO struct {
	UUID      lang.UUID `json:"uuid"`
	CreatedAt lang.Time `json:"created_at"`
	UpdatedAt lang.Time `json:"updated_at"`
	Creator   UserID    `json:"creator"`
	Owner     UserID    `json:"owner"`
	Updater   UserID    `json:"updater"`
}

BaseDTO 是通用的基本 DTO 结构

type BaseGetter

type BaseGetter interface {
	GetBase() *BaseVO
}

BaseGetter 是获取 BaseVO 的接口

type BaseVO

type BaseVO struct {
	Status     int         `json:"status"`
	Message    string      `json:"message"`
	Error      string      `json:"error"`
	Time       time.Time   `json:"time"`
	Timestamp  lang.Time   `json:"timestamp"`
	Pagination *Pagination `json:"pagination"`
}

BaseVO 是通用的基本 VO 结构

func (*BaseVO) GetBase

func (inst *BaseVO) GetBase() *BaseVO

GetBase 实现 BaseGetter

type ExampleDTO

type ExampleDTO struct {
	BaseDTO
}

ExampleDTO 是一个 VO 的例子

type ExampleVO

type ExampleVO struct {
	BaseVO

	Items []*ExampleDTO `json:"items"`
}

ExampleVO 是一个 VO 的例子

type Pagination

type Pagination struct {
	Number int64 `json:"number"` // 页码, first=1
	Size   int   `json:"size"`   // 页大小
}

Pagination 是通用的分页参数

func (*Pagination) Limit

func (inst *Pagination) Limit() int

Limit 用于 SQL 查询的页面大小

func (*Pagination) Offset

func (inst *Pagination) Offset() int64

Offset 用于 SQL 查询的条目位置

type UserID

type UserID int64

UserID 是通用的用户标识符

func ParseUserID

func ParseUserID(s string) (UserID, error)

ParseUserID 把字符串解析为 UserID

func (UserID) String

func (id UserID) String() string