// 通用返回json
// 所有的接口均返回此对象
type RetJSON struct {
    Code  int            `json:"code" example:"0"`
    Data  interface{}    `json:"data,omitempty"`
    Msg   string         `json:"msg,omitempty" example:"提示信息"`
    Count *int           `json:"count,omitempty"`
    Page  int            `json:"page,omitempty"`
    Limit int            `json:"limit,omitempty"`
    Extra *RespJsonExtra `json:"extra,omitempty"`
}

type RespJsonExtra struct {
    ReqID    string      `json:"requestID"`
    SQLs     interface{} `json:"sqls,omitempty"`
    ProcTime string      `json:"procTime" example:"0.2s"`
    TempData interface{} `json:"tempData,omitempty"`
}

add

请求参数 AddData 一般为模型中的字段，如有关联如预览图列表则有 profilePicIDList字段

edit

请求参数 EditData 一般为 id + AddData 并将AddData必填字段设置为非必填

detail

请求参数 id+scene 根据不同scene返回不同json 不传则返回 defaultScene，

admin scene 需要admin权限如请求用户详情 default scene返回信息较多，

profile scene 只返回id 昵称头像介绍4个字段

list

请求参数

page: 页码
limit：每页数量
filter：查询条件（db字段）
order：排序条件（db字段）
extra：其他参数定制化

ListData struct {
    Page   int                    `json:"page" binding:"omitempty,required,min=0"`
    Limit  int                    `json:"limit" binding:"omitempty,required,min=0,max=50"`
    Filter Filter                 `json:"filter" binding:""`
    Order  map[string]string      `json:"order" binding:""`
    Extra  map[string]interface{} `json:"extra" binding:""`
}

type (
	Filter     = map[string]FilterItem
	FilterCond string
	FilterItem struct {
		Condition FilterCond
		Val       interface{}
	}
)

const (
	// 筛选条件
	CondUndefined FilterCond = "undefined"
	// 数值
	CondEq           FilterCond = "eq"
	CondLt           FilterCond = "lt"
	CondElt          FilterCond = "elt"
	CondGt           FilterCond = "gt"
	CondEgt          FilterCond = "egt"
	CondNeq          FilterCond = "neq"
	CondBetweenValue FilterCond = "betweenValue"
	// 字符串
	CondEqString  FilterCond = "eqString"
	CondLike      FilterCond = "like"
	// ... other condition
	)

del

请求参数： ids id列表。根据id删除

如何快速创建一个模型的curd

// todo b站做个视频

编辑并运行 cmd/generate_model/main.go 编辑需要添加的模型会在models目录下 model.go文件编辑模型编辑文件中的 FilterNameMapDBField 此字段为查询条件对db字段的映射编辑文件中的 OrderKeyMap 此字段为排序字段对db字段的映射修改AddData EditData 编辑各种scene模型和构造函数如DefaultSceneModel AdminSceneModel
编辑并运行数据库迁移
添加路由

FAQs

What is github.com/real-web-world/go-api?

Package last updated on 22 Feb 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install