修改接口说明

This commit is contained in:
2025-06-12 09:18:25 +08:00
parent 3f5d0d7b2b
commit f7cffcae21
16 changed files with 57 additions and 55 deletions

View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type ListReq struct {
g.Meta `path:"/user/list" method:"get" tags:"User" summary:"获取用户列表"`
g.Meta `path:"/user/list" method:"get" tags:"User" summary:"(系统、商户门店后台)获取用户列表"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"页数"`
}
@ -13,7 +13,7 @@ type ListRes struct {
}
type InfoReq struct {
g.Meta `path:"/user/info" method:"get" tags:"User" summary:"获取用户信息"`
g.Meta `path:"/user/info" method:"get" tags:"User" summary:"(PC)获取用户信息"`
OpenId string `json:"openId" v:"required#OpenId不能为空" dc:"OpenId"`
}
@ -31,7 +31,7 @@ type InfoRes struct {
}
type UpdateReq struct {
g.Meta `path:"/user" method:"put" tags:"User" summary:"更新用户头像,昵称"`
g.Meta `path:"/user" method:"put" tags:"User" summary:"(PC)更新用户头像,昵称"`
Avatar string `json:"avatar" v:"required#头像不能为空" dc:"头像"`
Nickname string `json:"nickname" v:"required#昵称不能为空" dc:"昵称"`
}
@ -41,7 +41,7 @@ type UpdateRes struct {
}
type BindPhoneReq struct {
g.Meta `path:"/user/bindPhone" method:"post" tags:"User" summary:"绑定手机号"`
g.Meta `path:"/user/bindPhone" method:"post" tags:"User" summary:"(PC)绑定手机号"`
Phone string `json:"phone" v:"required#手机号不能为空" dc:"手机号"`
Code string `json:"code" v:"required#验证码不能为空" dc:"验证码"`
}
@ -51,7 +51,7 @@ type BindPhoneRes struct {
}
type GetPhoneCodeReq struct {
g.Meta `path:"/user/getPhoneCode" method:"post" tags:"User" summary:"获取手机验证码"`
g.Meta `path:"/user/getPhoneCode" method:"post" tags:"User" summary:"(PC)获取手机验证码"`
Phone string `json:"phone" v:"required#手机号不能为空" dc:"手机号"`
}
@ -59,7 +59,7 @@ type GetPhoneCodeRes struct {
Success bool `json:"success" dc:"是否成功"`
}
type GetUserBoundInfoReq struct {
g.Meta `path:"/user/boundInfo" method:"get" tags:"User" summary:"获取用户绑定信息"`
g.Meta `path:"/user/boundInfo" method:"get" tags:"User" summary:"(PC)获取用户绑定信息"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
}
type GetUserBoundInfoRes struct {
@ -67,7 +67,7 @@ type GetUserBoundInfoRes struct {
}
type GetBoundUrlReq struct {
g.Meta `path:"/user/boundUrl" method:"get" tags:"User" summary:"获取用户绑定url"`
g.Meta `path:"/user/boundUrl" method:"get" tags:"User" summary:"(PC)获取用户绑定url"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
BindType int `json:"bindType" v:"required|in:1,2#请选择绑定方式只能为1或2" dc:"绑定方式默认值11: qq; 2: wx" default:"1"`
AppName string `json:"appName" v:"required#请选择游戏" dc:"游戏名称"`
@ -77,7 +77,7 @@ type GetBoundUrlRes struct {
}
type GetUnboundUrlReq struct {
g.Meta `path:"/user/unBoundUrl" method:"get" tags:"User" summary:"获取用户解绑url"`
g.Meta `path:"/user/unBoundUrl" method:"get" tags:"User" summary:"(PC)获取用户解绑url"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
BindType int `json:"bindType" v:"required|in:1,2#请选择绑定方式只能为1或2" dc:"绑定方式默认值11: qq; 2: wx" default:"1"`
AppName string `json:"appName" v:"required#请选择游戏" dc:"游戏名称"`