denghui/arenax-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

调整接口分组

Browse Source
This commit is contained in:
chy
2025-06-27 15:35:56 +08:00
parent ba28d0621a
commit 854d6c2120
18 changed files with 83 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api/auth/v1/auth.go
View File

@ -27,14 +27,14 @@ type MerchantLoginRes struct {
}
type MerchantCodeReq struct {
g.Meta `path:"/merchant/code" method:"post" tags:"Merchant" summary:"(商户门店后台)商户获取短信验证码"`
g.Meta `path:"/merchant/code" method:"post" tags:"Backend/Merchant" summary:"(商户门店后台)商户获取短信验证码"`
Phone string `json:"phone" v:"required" dc:"手机号"`
}
type MerchantCodeRes struct{}
type MerchantRegisterReq struct {
g.Meta `path:"/merchant/register" method:"post" tags:"Merchant" summary:"(商户门店后台)商户注册"`
g.Meta `path:"/merchant/register" method:"post" tags:"Backend/Merchant" summary:"(商户门店后台)商户注册"`
Username string `json:"username" v:"required" dc:"用户名"`
Phone string `json:"phone" v:"required|regex:^1[3-9]\\d{9}$" dc:"手机号"`
Code string `json:"code" v:"required" dc:"验证码"`
@ -49,7 +49,7 @@ type MerchantRegisterRes struct {
}
type StoreLoginReq struct {
g.Meta `path:"/store/login" method:"post" tags:"Store" summary:"(商户门店后台)门店登录"`
g.Meta `path:"/store/login" method:"post" tags:"Backend/Store" summary:"(商户门店后台)门店登录"`
Username string `json:"username" v:"required" dc:"用户名"`
Password string `json:"password" v:"required" dc:"密码"`
}

4
api/desktop/v1/desktop.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type GetReq struct {
g.Meta `path:"/desktop" method:"get" tags:"Desktop" summary:"(PC)获取桌面信息"`
g.Meta `path:"/desktop" method:"get" tags:"PC/Desktop" summary:"(PC)获取桌面信息"`
StoreId int64 `json:"storeId" v:"required#请选择店铺" dc:"门店id"`
}
type GetRes struct {
@ -12,7 +12,7 @@ type GetRes struct {
}
type SaveReq struct {
g.Meta `path:"/desktop" method:"post" tags:"Desktop" summary:"(PC)保存桌面信息"`
g.Meta `path:"/desktop" method:"post" tags:"PC/Desktop" summary:"(PC)保存桌面信息"`
StoreId int64 `json:"storeId" v:"required#请选择店铺" dc:"门店id"`
TopComponentVisible int `json:"topComponentVisible" v:"in:1,2#显示隐藏只能选择1或2"`
RightComponentVisible int `json:"rightComponentVisible" v:"in:1,2#显示隐藏只能选择1或2"`

10
api/feedback/v1/feedback.go
View File

@ -6,7 +6,7 @@ import (
)
type ListReq struct {
g.Meta `path:"/feedback" method:"get" tags:"Feedback" summary:"(系统、商户门店后台)根据用户查询反馈列表"`
g.Meta `path:"/feedback" method:"get" tags:"Backend/Feedback" summary:"(系统、商户门店后台)根据用户查询反馈列表"`
//UserId int64 `json:"userId" v:"required#用户ID不能为空" dc:"用户ID"`
Status int `json:"status" v:"required#状态不能为空" dc:"状态"`
Page int `json:"page" v:"required#页数不能为空" dc:"页数"`
@ -21,7 +21,7 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/feedback" method:"post" tags:"Feedback" summary:"(PC)创建反馈"`
g.Meta `path:"/feedback" method:"post" tags:"PC/Feedback" summary:"(PC)创建反馈"`
Title string `json:"title" v:"required#标题不能为空" dc:"标题"`
Content string `json:"content" v:"required#反馈内容不能为空" dc:"反馈内容"`
FeedbackType int `json:"feedbackType" v:"required#反馈类型不能为空" dc:"反馈类型"`
@ -34,7 +34,7 @@ type CreateRes struct {
}
type UpdateReq struct {
g.Meta `path:"/feedback" method:"put" tags:"Feedback" summary:"(系统、商户门店后台)更新反馈"`
g.Meta `path:"/feedback" method:"put" tags:"PC/Feedback" summary:"(PC)更新反馈"`
Id int64 `json:"id" v:"required#ID不能为空" dc:"ID"`
Title string `json:"title" v:"required#标题不能为空" dc:"标题"`
Content string `json:"content" v:"required#反馈内容不能为空" dc:"反馈内容"`
@ -51,7 +51,7 @@ type UpdateRes struct {
//}
type UpdateReplyReq struct {
g.Meta `path:"/feedback/reply" method:"put" tags:"Feedback" summary:"(系统、商户门店后台)更新反馈回复"`
g.Meta `path:"/feedback/reply" method:"put" tags:"Backend/Feedback" summary:"(系统、商户门店后台)更新反馈回复"`
Id int64 `json:"id" v:"required#ID不能为空" dc:"ID"`
Reply string `json:"reply" v:"required#回复内容不能为空" dc:"回复内容"`
Status int `json:"status" v:"required#状态不能为空" dc:"状态"`
@ -62,7 +62,7 @@ type UpdateReplyRes struct {
}
type InfoFeedbackReq struct {
g.Meta `path:"/feedback/{id}" method:"get" tags:"Feedback" summary:"(系统、商户门店后台)获取反馈信息"`
g.Meta `path:"/feedback/{id}" method:"get" tags:"Backend/Feedback" summary:"(系统、商户门店后台)获取反馈信息"`
Id int64 `in:"path" json:"id" v:"required#ID不能为空" dc:"ID"`
}

6
api/game/v1/game.go
View File

@ -16,7 +16,7 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/game" method:"post" tags:"Game" summary:"(系统)创建游戏"`
g.Meta `path:"/game" method:"post" tags:"Backend/Game" summary:"(系统)创建游戏"`
GameID int64 `json:"gameId" v:"required#游戏ID不能为空" dc:"游戏ID"`
GameName string `json:"gameName" v:"required#游戏名称不能为空" dc:"游戏名称"`
GameCode string `json:"gameCode" v:"required#游戏代号不能为空" dc:"游戏代号"`
@ -29,7 +29,7 @@ type CreateRes struct {
}
type UpdateReq struct {
g.Meta `path:"/game" method:"put" tags:"Game" summary:"(系统)更新游戏"`
g.Meta `path:"/game" method:"put" tags:"Backend/Game" summary:"(系统)更新游戏"`
GameID int64 `json:"gameId" dc:"游戏ID"`
GameName string `json:"gameName" dc:"游戏名称"`
GameCode string `json:"gameCode" dc:"游戏代号"`
@ -43,7 +43,7 @@ type UpdateRes struct {
}
type DeleteReq struct {
g.Meta `path:"/game/{id}" method:"delete" tags:"Game" summary:"(系统)删除游戏"`
g.Meta `path:"/game/{id}" method:"delete" tags:"Backend/Game" summary:"(系统)删除游戏"`
ID int64 `json:"Id" v:"required#ID不能为空" dc:"ID"`
}

8
api/merchant/v1/merchant.go
View File

@ -6,7 +6,7 @@ import (
)
type ListReq struct {
g.Meta `path:"/merchant" method:"get" tags:"Merchant" summary:"(系统管理员)获取商户列表"`
g.Meta `path:"/merchant" method:"get" tags:"Backend/Merchant" summary:"(系统管理员)获取商户列表"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"每页数量"`
Status int `json:"status" dc:"状态：1=启用，2=禁用"`
@ -18,21 +18,21 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/merchant" method:"post" tags:"Merchant" summary:"(系统管理员)创建商户"`
g.Meta `path:"/merchant" method:"post" tags:"Backend/Merchant" summary:"(系统管理员)创建商户"`
}
type CreateRes struct {
Id int64 `json:"id" dc:"商户ID"`
}
type UpdateReq struct {
g.Meta `path:"/merchant" method:"put" tags:"Merchant" summary:"(系统管理员、商户管理员)更新商户"`
g.Meta `path:"/merchant" method:"put" tags:"Backend/Merchant" summary:"(系统管理员、商户管理员)更新商户"`
}
type UpdateRes struct {
Success bool `json:"success" dc:"是否成功"`
}
type AuditReq struct {
g.Meta `path:"/merchant/audit" method:"post" tags:"Merchant" summary:"(系统管理员)商户审核"`
g.Meta `path:"/merchant/audit" method:"post" tags:"Backend/Merchant" summary:"(系统管理员)商户审核"`
Id int64 `json:"id" v:"required" dc:"商户ID"`
AuditStatus int `json:"auditStatus" v:"required" dc:"审核状态：2=审核通过，3=审核拒绝" `
AuditRemark string `json:"auditRemark" dc:"审核备注"`

2
api/merchantAdmin/v1/merchantAdmin.go
View File

@ -5,7 +5,7 @@ import (
)
type MerchantAdminInfoReq struct {
g.Meta `path:"/merchant/info" method:"get" tags:"MerchantAdmin" summary:"(商户后台)获取商户管理员信息"`
g.Meta `path:"/merchant/info" method:"get" tags:"Backend/MerchantAdmin" summary:"(商户后台)获取商户管理员信息"`
}
type MerchantAdminInfoRes struct {
MerchantId int64 `json:"merchantId"`

20
api/reward/v1/reward.go
View File

@ -6,7 +6,7 @@ import (
)
type ListReq struct {
g.Meta `path:"/reward" method:"get" tags:"Reward" summary:"(系统、商户、门店后台)获取奖励列表"`
g.Meta `path:"/reward" method:"get" tags:"Backend/Reward" summary:"(系统、商户、门店后台)获取奖励列表"`
Name string `json:"name" dc:"名称"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"每页数量"`
@ -21,7 +21,7 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/reward" method:"post" tags:"Reward" summary:"(系统、商户、门店后台)创建奖励"`
g.Meta `path:"/reward" method:"post" tags:"Backend/Reward" summary:"(系统、商户、门店后台)创建奖励"`
StoreId int64 `json:"storeId" dc:"门店ID"`
Name string `json:"name" v:"required#名称不能为空" dc:"名称"`
RewardTypeId int64 `json:"rewardTypeId" v:"required#奖励类型ID不能为空" dc:"奖励类型ID"`
@ -47,7 +47,7 @@ type CreateRes struct {
}
type UpdateReq struct {
g.Meta `path:"/reward" method:"put" tags:"Reward" summary:"(系统、商户、门店后台)更新奖励"`
g.Meta `path:"/reward" method:"put" tags:"Backend/Reward" summary:"(系统、商户、门店后台)更新奖励"`
Id int64 `json:"id" v:"required#id不能为空" dc:"ID"`
Name string `json:"name" dc:"名称"`
RewardType int `json:"rewardType" dc:"奖励类型"`
@ -73,7 +73,7 @@ type UpdateRes struct {
}
type DeleteReq struct {
g.Meta `path:"/reward/{id}" method:"delete" tags:"Reward" summary:"(系统、商户、门店后台)删除奖励"`
g.Meta `path:"/reward/{id}" method:"delete" tags:"Backend/Reward" summary:"(系统、商户、门店后台)删除奖励"`
Id int64 `in:"path" json:"id" v:"required#ID不能为空" dc:"ID"`
Source int `json:"source" v:"required#来源不能为空" dc:"来源" d:"1"`
}
@ -211,7 +211,7 @@ type CallbackRes struct {
}
type GetLiftReq struct {
g.Meta `path:"/reward/getLift" method:"post" tags:"Reward" summary:"(PC)奖励领取"`
g.Meta `path:"/reward/getLift" method:"post" tags:"PC/Reward" summary:"(PC)奖励领取"`
RewradType int `json:"rewardType" v:"required#奖励类型不能为空" dc:"奖励类型"`
RewradId int `json:"rewardId" v:"required#奖励id不能为空" dc:"奖励id"`
PopenId string `json:"popenid" v:"required#popenId不能为空" dc:"popenId不能为空"`
@ -231,7 +231,7 @@ type GetLiftRes struct {
}
type GetGoodsListReq struct {
g.Meta `path:"/reward/goods" method:"get" tags:"Reward" summary:"(tencent)获取物品列表"`
g.Meta `path:"/reward/goods" method:"get" tags:"PC/Reward" summary:"(PC)获取物品列表"`
Appfilter string `json:"appfilter" dc:"按照gid过滤游戏"`
BigTime int64 `json:"bigTime" v:"required#大时间不能为空" dc:"大时间：如果要控制时间范围，大的时间传这里"`
Pageidx string `json:"pageidx" dc:"分页索引"`
@ -249,7 +249,7 @@ type GetGoodsListRes struct {
}
type GetGoodsReq struct {
g.Meta `path:"/reward/getGoods" method:"post" tags:"Reward" summary:"物品兑换"`
g.Meta `path:"/reward/getGoods" method:"post" tags:"PC/Reward" summary:"(PC)物品兑换"`
Water Water `json:"water" v:"required#物品流水，从背包列表获取的water透传回来（water类型参考GetGift接口的water结构）" dc:"礼包列表"`
AreaId int64 `json:"areaId" dc:"大区Id"`
GameId int64 `json:"gid" v:"required#游戏id不能为空" dc:"游戏Id"`
@ -260,7 +260,7 @@ type GetGoodsRes struct {
}
type GetGoodsDetailsReq struct {
g.Meta `path:"/reward/goodsDetails" method:"post" tags:"Reward" summary:"(PC)物品详情"`
g.Meta `path:"/reward/goodsDetails" method:"post" tags:"PC/Reward" summary:"(PC)物品详情"`
Winningtime int64 `json:"winningtime" dc:"用户领取礼包时间"`
Orderid string `json:"orderid" v:"required#流水订单id不能为空" dc:"用户领取流水订单id"`
IsActinfo int64 `json:"IsActinfo" dc:"是否需要活动相关信息 0：默认需要 1：不需要"`
@ -274,7 +274,7 @@ type GetGoodsDetailsRes struct {
}
type OperateTaskRewardReq struct {
g.Meta `path:"/reward/taskReward" method:"post" tags:"Reward" summary:"添加任务奖励"`
g.Meta `path:"/reward/taskReward" method:"post" tags:"Backend/Reward" summary:"(系统管理员、商户管理员、门店管理员)添加任务奖励"`
Type int `json:"type" v:"required#操作类型只能为1或2,1是添加、2是删除" dc:"操作类型"`
TaskId int64 `json:"taskId" v:"required#任务id不能为空" dc:"任务Id"`
RewardId int64 `json:"rewardId" v:"required#奖励id不能为空" dc:"奖励Id"`
@ -284,7 +284,7 @@ type OperateTaskRewardRes struct {
}
type GetUserRewardsCanClaimListReq struct {
g.Meta `path:"/reward/canClaim" method:"get" tags:"Reward" summary:"(PC)获取用户可领取的奖励列表"`
g.Meta `path:"/reward/canClaim" method:"get" tags:"PC/Reward" summary:"(PC)获取用户可领取的奖励列表"`
StoreId int64 `json:"storeId" dc:"门店id"`
NetbarAccount string `json:"netbarAccount" dc:"网吧账号"`
TaskId string `json:"taskId" dc:"任务id" v:"required#任务id不能为空"`

8
api/rewardType/v1/rewardType.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type ListReq struct {
g.Meta `path:"/rewardType" method:"get" tags:"RewardType" summary:"(系统、商户、门店后台)获取奖励类型列表"`
g.Meta `path:"/rewardType" method:"get" tags:"Backend/RewardType" summary:"(系统、商户、门店后台)获取奖励类型列表"`
Name string `json:"name" dc:"名称"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"每页数量"`
@ -17,7 +17,7 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/rewardType" method:"post" tags:"RewardType" summary:"(系统、商户、门店后台)创建奖励类型"`
g.Meta `path:"/rewardType" method:"post" tags:"Backend/RewardType" summary:"(系统、商户、门店后台)创建奖励类型"`
Name string `json:"name" v:"required#名称不能为空" dc:"名称"`
StoreId int64 `json:"storeId" dc:"门店ID"`
Source int `json:"source" v:"in:1,2#来源只能为1或2" dc:"来源"`
@ -29,7 +29,7 @@ type CreateRes struct {
}
type UpdateReq struct {
g.Meta `path:"/rewardType" method:"put" tags:"RewardType" summary:"(系统、商户、门店后台)更新奖励类型"`
g.Meta `path:"/rewardType" method:"put" tags:"Backend/RewardType" summary:"(系统、商户、门店后台)更新奖励类型"`
Id int64 `json:"id" v:"required#ID不能为空" dc:"Id"`
Name string `json:"name" v:"required#名称不能为空" dc:"名称"`
StoreId int64 `json:"storeId" dc:"门店ID"`
@ -41,7 +41,7 @@ type UpdateRes struct {
}
type DeleteReq struct {
g.Meta `path:"/rewardType/{id}" method:"delete" tags:"RewardType" summary:"(系统、商户、门店后台)删除奖励类型"`
g.Meta `path:"/rewardType/{id}" method:"delete" tags:"Backend/RewardType" summary:"(系统、商户、门店后台)删除奖励类型"`
Id int64 `in:"path" json:"id" v:"required#ID不能为空" dc:"Id"`
}

10
api/role/v1/role.go
View File

@ -6,7 +6,7 @@ import (
// ListReq 获取角色列表请求参数
type ListReq struct {
g.Meta `path:"/role" method:"get" tags:"Role" summary:"(系统、商户门店后台)获取角色列表"`
g.Meta `path:"/role" method:"get" tags:"Backend/Role" summary:"(系统、商户门店后台)获取角色列表"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"每页数量"`
Status int `json:"status" dc:"状态：1=启用，2=禁用"`
@ -20,7 +20,7 @@ type ListRes struct {
// CreateReq 创建角色请求参数
type CreateReq struct {
g.Meta `path:"/role" method:"post" tags:"Role" summary:"(系统、商户门店后台)创建角色"`
g.Meta `path:"/role" method:"post" tags:"Backend/Role" summary:"(系统、商户门店后台)创建角色"`
Name string `json:"name" v:"required" dc:"角色名称"`
Code string `json:"code" v:"required" dc:"角色编码"`
Description string `json:"description" dc:"角色描述"`
@ -34,7 +34,7 @@ type CreateRes struct {
// UpdateReq 更新角色请求参数
type UpdateReq struct {
g.Meta `path:"/role" method:"put" tags:"Role" summary:"(系统、商户门店后台)更新角色"`
g.Meta `path:"/role" method:"put" tags:"Backend/Role" summary:"(系统、商户门店后台)更新角色"`
Id int64 `json:"id" v:"required" dc:"角色ID"`
Name string `json:"name" v:"required" dc:"角色名称"`
Code string `json:"code" v:"required" dc:"角色编码"`
@ -49,7 +49,7 @@ type UpdateRes struct {
// DeleteReq 删除角色请求参数
type DeleteReq struct {
g.Meta `path:"/role/{id}" method:"delete" tags:"Role" summary:"(系统、商户门店后台)删除角色"`
g.Meta `path:"/role/{id}" method:"delete" tags:"Backend/Role" summary:"(系统、商户门店后台)删除角色"`
Id int64 `json:"id" in:"path" v:"required" dc:"角色ID"`
}
@ -59,7 +59,7 @@ type DeleteRes struct {
}
type BatchDeleteReq struct {
g.Meta `path:"/role" method:"delete" tags:"Role" summary:"(系统、商户门店后台)批量删除角色"`
g.Meta `path:"/role" method:"delete" tags:"Backend/Role" summary:"(系统、商户门店后台)批量删除角色"`
Ids []int `json:"ids" v:"required" dc:"角色ID"`
}
type BatchDeleteRes struct {

2
api/statistic/v1/statistic.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type GetOnlineDeviceReq struct {
g.Meta `path:"/statistic/onlineDevice" method:"get" tags:"Statistic" summary:"获取门店设备在线列表"`
g.Meta `path:"/statistic/onlineDevice" method:"get" tags:"Backend/Statistic" summary:"(系统、商户、门店)获取门店设备在线列表"`
NetbarAccount string `json:"netbarAccount" v:"required#网吧网关账号不能为空" dc:"网吧网关账号"`
}
type GetOnlineDeviceRes struct {

18
api/store/v1/store.go
View File

@ -5,7 +5,7 @@ import (
)
type ListReq struct {
g.Meta `path:"/store" method:"get" tags:"Store" summary:"(系统、商户门店后台)获取门店列表"`
g.Meta `path:"/store" method:"get" tags:"Backend/Store" summary:"(系统、商户门店后台)获取门店列表"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"每页数量"`
MerchantId int `json:"merchantId" dc:"商户ID"`
@ -15,7 +15,7 @@ type ListRes struct {
Total int `json:"total" dc:"总数"`
}
type CreateReq struct {
g.Meta `path:"/store" method:"post" tags:"Store" summary:"(商户门店后台)创建门店"`
g.Meta `path:"/store" method:"post" tags:"Backend/Store" summary:"(商户门店后台)创建门店"`
Name string `json:"name" v:"required" dc:"门店名称"`
ContactName string `json:"contactName" v:"required" dc:"联系人"`
ContactPhone string `json:"contactPhone" v:"required" dc:"联系人电话"`
@ -24,7 +24,7 @@ type CreateRes struct {
Id int64 `json:"id" dc:"门店ID"`
}
type UpdateReq struct {
g.Meta `path:"/store" method:"put" tags:"Store" summary:"(系统、商户门店后台)更新门店"`
g.Meta `path:"/store" method:"put" tags:"Backend/Store" summary:"(系统、商户门店后台)更新门店"`
Id int64 `json:"id" v:"required" dc:"门店ID"`
Name string `json:"name" v:"required" dc:"门店名称"`
Address string `json:"address" v:"required" dc:"门店地址"`
@ -36,7 +36,7 @@ type UpdateRes struct {
Success bool `json:"success" dc:"是否成功"`
}
type DeleteReq struct {
g.Meta `path:"/store" method:"delete" tags:"Store" summary:"(系统、商户门店后台)删除门店"`
g.Meta `path:"/store" method:"delete" tags:"Backend/Store" summary:"(系统、商户门店后台)删除门店"`
Id int64 `json:"id" v:"required" dc:"门店ID"`
}
type DeleteRes struct {
@ -44,7 +44,7 @@ type DeleteRes struct {
}
type AddIpReq struct {
g.Meta `path:"/store/addIp" method:"post" tags:"Store" summary:"(系统、商户门店后台)添加门店IP"`
g.Meta `path:"/store/addIp" method:"post" tags:"Backend/Store" summary:"(系统、商户门店后台)添加门店IP"`
StoreId int64 `json:"storeId" v:"required" dc:"门店ID"`
Ip string `json:"ip" v:"required" dc:"IP"`
Remark string `json:"remark" dc:"备注"`
@ -55,7 +55,7 @@ type AddIpRes struct {
}
type DeleteIpReq struct {
g.Meta `path:"/store/del/{id}" method:"delete" tags:"Store" summary:"(系统、商户门店后台)删除门店IP"`
g.Meta `path:"/store/del/{id}" method:"delete" tags:"Backend/Store" summary:"(系统、商户门店后台)删除门店IP"`
Id int64 `json:"id" v:"required" dc:"id"`
}
@ -64,7 +64,7 @@ type DeleteIpRes struct {
}
type UpdateIpReq struct {
g.Meta `path:"/store/updateIp" method:"put" tags:"Store" summary:"(系统、商户门店后台)更新门店IP"`
g.Meta `path:"/store/updateIp" method:"put" tags:"Backend/Store" summary:"(系统、商户门店后台)更新门店IP"`
Id int64 `json:"id" v:"required" dc:"id"`
//StoreId int64 `json:"storeId" v:"required" dc:"storeId"`
Ip string `json:"ip" v:"required" dc:"IP"`
@ -76,7 +76,7 @@ type UpdateIpRes struct {
}
type GetIpListReq struct {
g.Meta `path:"/store/getIpList" method:"get" tags:"Store" summary:"(系统、商户门店后台)获取门店IP列表"`
g.Meta `path:"/store/getIpList" method:"get" tags:"Backend/Store" summary:"(系统、商户门店后台)获取门店IP列表"`
StoreId int64 `json:"storeId" dc:"门店ID"`
Page int `json:"page" v:"required" dc:"页数"`
Size int `json:"size" v:"required" dc:"每页数量"`
@ -87,7 +87,7 @@ type GetIpListRes struct {
Total int64 `json:"total" dc:"总数"`
}
type DetailReq struct {
g.Meta `path:"/store/detail" method:"get" tags:"Store" summary:"(系统、商户门店后台)门店详情"`
g.Meta `path:"/store/detail" method:"get" tags:"Backend/Store" summary:"(系统、商户门店后台)门店详情"`
NetbarAccount string `json:"netbarAccount" v:"required" dc:"门店账号"`
}
type DetailRes struct {

12
api/storeAdmin/v1/storeAdmin.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type InfoReq struct {
g.Meta `path:"/store/admin/info" method:"get" tags:"StoreAdmin" summary:"(系统、商户门店后台)获取门店管理员信息"`
g.Meta `path:"/store/admin/info" method:"get" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)获取门店管理员信息"`
}
type InfoRes struct {
@ -11,7 +11,7 @@ type InfoRes struct {
Username string `json:"username"`
}
type ListReq struct {
g.Meta `path:"/store/admin" method:"get" tags:"StoreAdmin" summary:"(系统、商户门店后台)门店管理员列表"`
g.Meta `path:"/store/admin" method:"get" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)门店管理员列表"`
Page int `json:"page" v:"required#页数不能为空"`
Size int `json:"size" v:"required#页大小不能为空"`
StoreId int64 `json:"storeId" v:"required#门店ID不能为空"`
@ -22,7 +22,7 @@ type ListRes struct {
}
type CreateReq struct {
g.Meta `path:"/store/admin" method:"post" tags:"StoreAdmin" summary:"(系统、商户门店后台)创建门店管理员"`
g.Meta `path:"/store/admin" method:"post" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)创建门店管理员"`
Realname string `json:"realname" v:"required#真实姓名不能为空"`
StoreId int64 `json:"storeId" v:"required#门店ID不能为空"`
Username string `json:"username" v:"required#用户名不能为空"`
@ -36,7 +36,7 @@ type CreateRes struct {
}
type UpdateReq struct {
g.Meta `path:"/store/admin" method:"put" tags:"StoreAdmin" summary:"(系统、商户门店后台)更新门店管理员"`
g.Meta `path:"/store/admin" method:"put" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)更新门店管理员"`
Id int64 `json:"id" v:"required#门店管理员ID不能为空"`
Realname string `json:"realname" v:"required#真实姓名不能为空"`
StoreRoleId int `json:"storeRoleId" v:"required#角色ID不能为空"`
@ -46,7 +46,7 @@ type UpdateRes struct {
Success bool `json:"success"`
}
type EditPasswordReq struct {
g.Meta `path:"/store/admin/password" method:"post" tags:"StoreAdmin" summary:"(系统、商户门店后台)修改门店管理员密码"`
g.Meta `path:"/store/admin/password" method:"post" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)修改门店管理员密码"`
Id int64 `json:"id" v:"required#门店管理员ID不能为空"`
OldPass string `json:"oldPass" v:"required#旧密码不能为空"`
NewPass string `json:"newPass" v:"required#新密码不能为空"`
@ -55,7 +55,7 @@ type EditPasswordRes struct {
Success bool `json:"success"`
}
type DeleteReq struct {
g.Meta `path:"/store/admin/{id}" method:"delete" tags:"StoreAdmin" summary:"(系统、商户门店后台)删除门店管理员"`
g.Meta `path:"/store/admin/{id}" method:"delete" tags:"Backend/StoreAdmin" summary:"(系统、商户门店后台)删除门店管理员"`
Id int64 `in:"path" json:"id" v:"required#门店管理员ID不能为空"`
}
type DeleteRes struct {

8
api/storeRole/v1/storeRole.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type ListReq struct {
g.Meta `path:"/store/role" method:"get" tags:"StoreRole" summary:"(系统、商户门店后台)获取门店角色列表"`
g.Meta `path:"/store/role" method:"get" tags:"Backend/StoreRole" summary:"(系统、商户门店后台)获取门店角色列表"`
StoreId int64 `json:"storeId" v:"required#门店ID不能为空" dc:"门店ID"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"页大小"`
@ -13,7 +13,7 @@ type ListRes struct {
Total int `json:"total"`
}
type CreateReq struct {
g.Meta `path:"/store/role" method:"post" tags:"StoreRole" summary:"(系统、商户门店后台)创建门店角色"`
g.Meta `path:"/store/role" method:"post" tags:"Backend/StoreRole" summary:"(系统、商户门店后台)创建门店角色"`
StoreId int64 `json:"storeId" v:"required#门店ID不能为空" dc:"门店ID"`
Name string `json:"name" v:"required#角色名称不能为空" dc:"角色名称"`
}
@ -21,7 +21,7 @@ type CreateRes struct {
Id int64 `json:"id"`
}
type UpdateReq struct {
g.Meta `path:"/store/role" method:"put" tags:"StoreRole" summary:"(系统、商户门店后台)更新门店角色"`
g.Meta `path:"/store/role" method:"put" tags:"Backend/StoreRole" summary:"(系统、商户门店后台)更新门店角色"`
Id int64 `json:"id" v:"required#角色ID不能为空" dc:"角色ID"`
Name string `json:"name" v:"required#角色名称不能为空" dc:"角色名称"`
}
@ -29,7 +29,7 @@ type UpdateRes struct {
Success bool `json:"success" dc:"是否成功"`
}
type DeleteReq struct {
g.Meta `path:"/store/role/{id}" method:"delete" tags:"StoreRole" summary:"(系统、商户门店后台)删除门店角色"`
g.Meta `path:"/store/role/{id}" method:"delete" tags:"Backend/StoreRole" summary:"(系统、商户门店后台)删除门店角色"`
Id int64 `in:"path" json:"id" v:"required#角色ID不能为空" dc:"角色ID"`
}
type DeleteRes struct {

14
api/task/v1/task.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type RankingReq struct {
g.Meta `path:"/task/ranking" method:"get" tags:"Task" summary:"(PC)任务排行榜"`
g.Meta `path:"/task/ranking" method:"get" tags:"PC/Task" summary:"(PC)任务排行榜"`
StoreId int `json:"storeId" dc:"门店id"`
NetBarAccount string `json:"netBarAccount" dc:"网关账号"`
Page int `json:"page" dc:"页数"`
@ -19,7 +19,7 @@ type RankingRes struct {
}
type NonLoginTaskListReq struct {
g.Meta `path:"/task/getNonLoginTaskList" method:"get" tags:"Task" summary:"(PC)网吧未登录、已登录未绑定任务列表"`
g.Meta `path:"/task/getNonLoginTaskList" method:"get" tags:"PC/Task" summary:"(PC)网吧未登录、已登录未绑定任务列表"`
NetBarAccount string `json:"netBarAccount" v:"required#网关账号不能为空" dc:"网关账号"`
Gid int `json:"gid" v:"required#游戏唯一id不能为空" dc:"游戏唯一id"`
Num int `json:"num" v:"required#不能为空" dc:""`
@ -36,7 +36,7 @@ type NonLoginTaskListRes struct {
}
type GetLoginTaskListReq struct {
g.Meta `path:"/task/getLoginTaskList" method:"get" tags:"Task" summary:"(PC)网吧已登录已绑定任务列表"`
g.Meta `path:"/task/getLoginTaskList" method:"get" tags:"PC/Task" summary:"(PC)网吧已登录已绑定任务列表"`
NetBarAccount string `json:"netBarAccount" v:"required#网关账号不能为空" dc:"网关账号"`
Num int `json:"num" v:"required#不能为空" dc:""`
Pageidx string `json:"pageidx" dc:"分页索引"`
@ -52,7 +52,7 @@ type GetLoginTaskListRes struct {
}
type ListReq struct {
g.Meta `path:"/task/completed/list" method:"get" tags:"Task" summary:"(商户、门店)用户任务已完成列表"`
g.Meta `path:"/task/completed/list" method:"get" tags:"Backend/Task" summary:"(商户、门店)用户任务已完成列表"`
StoreId int `json:"storeId" dc:"门店 id"`
Page int `json:"page" dc:"页数"`
Size int `json:"size" dc:"条数"`
@ -65,7 +65,7 @@ type ListRes struct {
// SelectorReq 系统管理员任务列表二级选择器
type SelectorReq struct {
g.Meta `path:"/task/selector" method:"get" tags:"Task" summary:"系统管理员任务列表二级选择器"`
g.Meta `path:"/task/selector" method:"get" tags:"Backend/Task" summary:"(系统后台)系统管理员任务列表二级选择器"`
}
type SelectorRes struct {
@ -74,7 +74,7 @@ type SelectorRes struct {
// GetTaskReq 添加任务记录
type GetTaskReq struct {
g.Meta `path:"/task/get" method:"post" tags:"Task" summary:"(PC)任务领取"`
g.Meta `path:"/task/get" method:"post" tags:"PC/Task" summary:"(PC)任务领取"`
TaskId string `json:"taskId" v:"required#任务id不能为空" dc:"任务id"`
StoreId int `json:"storeId" dc:"门店 id、网关账号必传一个"`
NetBarAccount string `json:"netBarAccount" dc:"门店 id、网关账号必传一个"`
@ -87,7 +87,7 @@ type GetTaskRes struct {
}
type GetUserTaskRecordsListReq struct {
g.Meta `path:"/task/records" method:"get" tags:"Task" summary:"(PC)用户任务记录列表"`
g.Meta `path:"/task/records" method:"get" tags:"PC/Task" summary:"(PC)用户任务记录列表"`
TaskId string `json:"taskId" dc:"任务 id"`
StoreId int `json:"storeId" dc:"门店 id"`
NetbarAccount string `json:"netbarAccount" dc:"网关账号"`

8
api/upload/v1/upload.go
View File

@ -6,7 +6,7 @@ import (
)
type UploadReq struct {
g.Meta `path:"/upload/image" method:"post" tags:"WEB" summary:"上传文件"`
g.Meta `path:"/upload/image" method:"post" tags:"Backend/WEB" summary:"(系统、商户、门店)上传文件"`
File *ghttp.UploadFile `json:"file"`
}
type UploadRes struct {
@ -14,7 +14,7 @@ type UploadRes struct {
}
type UploadGameImgReq struct {
g.Meta `path:"/upload/game" method:"post" tags:"WEB" summary:"上传游戏图标文件"`
g.Meta `path:"/upload/game" method:"post" tags:"Backend/WEB" summary:"上传游戏图标文件"`
File *ghttp.UploadFile `json:"file"`
}
type UploadGameImgRes struct {
@ -22,7 +22,7 @@ type UploadGameImgRes struct {
}
type UploadUserImgReq struct {
g.Meta `path:"/upload/user" method:"post" tags:"WEB" summary:"上传用户头像文件"`
g.Meta `path:"/upload/user" method:"post" tags:"WEB" summary:"(系统、商户、门店、PC)上传用户头像文件"`
File *ghttp.UploadFile `json:"file"`
}
@ -31,7 +31,7 @@ type UploadUserImgRes struct {
}
type UploadRewardImgReq struct {
g.Meta `path:"/upload/reward" method:"post" tags:"WEB" summary:"上传奖励图标文件"`
g.Meta `path:"/upload/reward" method:"post" tags:"Backend/WEB" summary:"(系统、商户、门店)上传奖励图标文件"`
File *ghttp.UploadFile `json:"file"`
}
type UploadRewardImgRes struct {

22
api/user/v1/user.go
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:"Backend/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:"(PC)获取用户信息"`
g.Meta `path:"/user/info" method:"get" tags:"PC/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:"(PC)更新用户头像,昵称"`
g.Meta `path:"/user" method:"put" tags:"PC/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:"(PC)绑定手机号"`
g.Meta `path:"/user/bindPhone" method:"post" tags:"PC/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:"(PC)获取手机验证码"`
g.Meta `path:"/user/getPhoneCode" method:"post" tags:"PC/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:"(PC)获取用户绑定信息"`
g.Meta `path:"/user/boundInfo" method:"get" tags:"PC/User" summary:"(PC)获取用户绑定信息"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
}
type GetUserBoundInfoRes struct {
@ -71,7 +71,7 @@ type GetUserBoundInfoRes struct {
}
type GetBoundUrlReq struct {
g.Meta `path:"/user/boundUrl" method:"get" tags:"User" summary:"(PC)获取用户绑定url"`
g.Meta `path:"/user/boundUrl" method:"get" tags:"PC/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:"绑定方式，默认值1，1: qq; 2: wx" default:"1"`
AppName string `json:"appName" v:"required#请选择游戏" dc:"游戏名称"`
@ -81,7 +81,7 @@ type GetBoundUrlRes struct {
}
type GetUnboundUrlReq struct {
g.Meta `path:"/user/unBoundUrl" method:"get" tags:"User" summary:"(PC)获取用户解绑url"`
g.Meta `path:"/user/unBoundUrl" method:"get" tags:"PC/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:"绑定方式，默认值1，1: qq; 2: wx" default:"1"`
AppName string `json:"appName" v:"required#请选择游戏" dc:"游戏名称"`
@ -92,7 +92,7 @@ type GetUnboundUrlRes struct {
}
type DelUserReq struct {
g.Meta `path:"/user/del/{id}" method:"delete" tags:"User" summary:"(PC)删除用户"`
g.Meta `path:"/user/del/{id}" method:"delete" tags:"Backend/User" summary:"(系统、商户、门店)删除用户"`
Id int `json:"id" v:"required#用户id不能为空" dc:"用户id"`
}
@ -101,7 +101,7 @@ type DelUserRes struct {
}
type GetUserGameRoleListReq struct {
g.Meta `path:"/user/gameRoleList" method:"get" tags:"User" summary:"(PC)获取用户游戏角色列表"`
g.Meta `path:"/user/gameRoleList" method:"get" tags:" PC/User" summary:"(PC)获取用户游戏角色列表"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
GameId int `json:"gameId" v:"required#gameId不能为空" dc:"游戏id"`
Area int `json:"area" v:"required#area不能为空" dc:"游戏区"`
@ -112,7 +112,7 @@ type GetUserGameRoleListRes struct {
}
type GetGamelifePackageUrlReq struct {
g.Meta `path:"/user/packageUrl" method:"get" tags:"User" summary:"获取GameLife游戏包的url"`
g.Meta `path:"/user/packageUrl" method:"get" tags:"PC/User" summary:"(PC)获取GameLife游戏包的url"`
PopenId string `json:"popenId" v:"required#popenId不能为空" dc:"用户详情接口返回的 wxPopenId 或者是 qqPopenId"`
BindType int `json:"bindType" v:"required|in:1,2#请选择绑定方式，只能为1或2" dc:"绑定方式，默认值1，1: qq; 2: wx" default:"1"`
GameCode string `json:"gameCode" v:"required#请选择游戏" dc:"游戏名称"`

2
api/verify/v1/verify.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type VerifyReq struct {
g.Meta `path:"/verify" method:"post" tags:"Verify" summary:"验证"`
g.Meta `path:"/verify" method:"post" tags:"Verify" summary:"()验证"`
VerifySign string `json:"verifySign" v:"required#验签不能为空" dc:"验签"`
}

6
api/wx/v1/wx.go
View File

@ -3,7 +3,7 @@ package v1
import "github.com/gogf/gf/v2/frame/g"
type WeChatLoginReq struct {
g.Meta `path:"/wechat/login" method:"post" tags:"WeChat" summary:"(PC)获取微信二维码登录"`
g.Meta `path:"/wechat/login" method:"post" tags:"PC/WeChat" summary:"(PC)获取微信二维码登录"`
SceneId string `json:"sceneId" v:"required" dc:"场景ID"`
}
type WeChatLoginRes struct {
@ -35,7 +35,7 @@ type WeChatVertifyRes struct {
}
type WeChatPollingReq struct {
g.Meta `path:"/wechat/polling" method:"post" tags:"WeChat" summary:"(PC)微信长轮询"`
g.Meta `path:"/wechat/polling" method:"post" tags:"PC/WeChat" summary:"(PC)微信长轮询"`
SceneId string `json:"sceneId" v:"required" dc:"场景ID"`
}
type WeChatPollingRes struct {
@ -44,7 +44,7 @@ type WeChatPollingRes struct {
}
type GetWechatSceneIdReq struct {
g.Meta `path:"/wechat/sceneId" method:"get" tags:"WeChat" summary:"(PC)获取微信场景ID"`
g.Meta `path:"/wechat/sceneId" method:"get" tags:"PC/WeChat" summary:"(PC)获取微信场景ID"`
NetbarAccount string `json:"netbarAccount" v:"required" dc:"网关账号"`
}