migu_music_server/docs/admin/admin_swagger.yaml
2025-03-28 14:07:20 +08:00

4086 lines
94 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

definitions:
dto.GetSetSysConfigReq:
properties:
configKey:
type: string
configValue:
type: string
type: object
dto.PassWord:
properties:
newPassword:
type: string
oldPassword:
type: string
type: object
dto.ResetSysUserPwdReq:
properties:
createBy:
type: integer
password:
type: string
updateBy:
type: integer
userId:
description: 用户ID
type: integer
type: object
dto.RoleDataScopeReq:
properties:
dataScope:
type: string
deptIds:
items:
type: integer
type: array
roleId:
type: integer
required:
- dataScope
- roleId
type: object
dto.SysApiDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysApiUpdateReq:
properties:
action:
type: string
createBy:
type: integer
handle:
type: string
id:
description: 编码
type: integer
path:
type: string
title:
type: string
type:
type: string
updateBy:
type: integer
type: object
dto.SysConfigByKeyReq:
properties:
configKey:
type: string
type: object
dto.SysConfigControl:
properties:
configKey:
type: string
configName:
type: string
configType:
type: string
configValue:
type: string
createBy:
type: integer
id:
description: 编码
type: integer
isFrontend:
type: string
remark:
type: string
updateBy:
type: integer
type: object
dto.SysDeptDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysDeptInsertReq:
properties:
createBy:
type: integer
deptId:
description: 编码
type: integer
deptName:
description: 部门名称
type: string
deptPath:
description: 路径
type: string
email:
description: 邮箱
type: string
leader:
description: 负责人
type: string
parentId:
description: 上级部门
type: integer
phone:
description: 手机
type: string
sort:
description: 排序
type: integer
status:
description: 状态
type: integer
updateBy:
type: integer
type: object
dto.SysDeptUpdateReq:
properties:
createBy:
type: integer
deptId:
description: 编码
type: integer
deptName:
description: 部门名称
type: string
deptPath:
description: 路径
type: string
email:
description: 邮箱
type: string
leader:
description: 负责人
type: string
parentId:
description: 上级部门
type: integer
phone:
description: 手机
type: string
sort:
description: 排序
type: integer
status:
description: 状态
type: integer
updateBy:
type: integer
type: object
dto.SysDictDataDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysDictDataGetAllResp:
properties:
label:
type: string
value:
type: string
type: object
dto.SysDictDataInsertReq:
properties:
createBy:
type: integer
cssClass:
type: string
default:
type: string
dictLabel:
type: string
dictSort:
type: integer
dictType:
type: string
dictValue:
type: string
isDefault:
type: string
listClass:
type: string
remark:
type: string
status:
type: integer
updateBy:
type: integer
type: object
dto.SysDictDataUpdateReq:
properties:
createBy:
type: integer
cssClass:
type: string
default:
type: string
dictLabel:
type: string
dictSort:
type: integer
dictType:
type: string
dictValue:
type: string
id:
type: integer
isDefault:
type: string
listClass:
type: string
remark:
type: string
status:
type: integer
updateBy:
type: integer
type: object
dto.SysDictTypeDeleteReq:
properties:
createBy:
type: integer
ids:
items:
type: integer
type: array
updateBy:
type: integer
type: object
dto.SysDictTypeInsertReq:
properties:
createBy:
type: integer
dictName:
type: string
dictType:
type: string
id:
type: integer
remark:
type: string
status:
type: integer
updateBy:
type: integer
type: object
dto.SysDictTypeUpdateReq:
properties:
createBy:
type: integer
dictName:
type: string
dictType:
type: string
id:
type: integer
remark:
type: string
status:
type: integer
updateBy:
type: integer
type: object
dto.SysLoginLogDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysMenuDeleteReq:
properties:
createBy:
type: integer
ids:
items:
type: integer
type: array
updateBy:
type: integer
type: object
dto.SysMenuInsertReq:
properties:
action:
description: 请求方式
type: string
apis:
items:
type: integer
type: array
breadcrumb:
description: 是否面包屑
type: string
component:
description: 组件
type: string
createBy:
type: integer
icon:
description: 图标
type: string
isFrame:
description: 是否frame
type: string
menuId:
description: 编码
type: integer
menuName:
description: 菜单name
type: string
menuType:
description: 菜单类型
type: string
noCache:
description: 是否缓存
type: boolean
parentId:
description: 上级菜单
type: integer
path:
description: 路径
type: string
paths:
description: id路径
type: string
permission:
description: 权限编码
type: string
sort:
description: 排序
type: integer
sysApi:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: array
title:
description: 显示名称
type: string
updateBy:
type: integer
visible:
description: 是否显示
type: string
type: object
dto.SysMenuUpdateReq:
properties:
action:
description: 请求方式
type: string
apis:
items:
type: integer
type: array
breadcrumb:
description: 是否面包屑
type: string
component:
description: 组件
type: string
createBy:
type: integer
icon:
description: 图标
type: string
isFrame:
description: 是否frame
type: string
menuId:
description: 编码
type: integer
menuName:
description: 菜单name
type: string
menuType:
description: 菜单类型
type: string
noCache:
description: 是否缓存
type: boolean
parentId:
description: 上级菜单
type: integer
path:
description: 路径
type: string
paths:
description: id路径
type: string
permission:
description: 权限编码
type: string
sort:
description: 排序
type: integer
sysApi:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: array
title:
description: 显示名称
type: string
updateBy:
type: integer
visible:
description: 是否显示
type: string
type: object
dto.SysOperaLogDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysPostDeleteReq:
properties:
createBy:
type: integer
ids:
items:
type: integer
type: array
updateBy:
type: integer
type: object
dto.SysPostInsertReq:
properties:
createBy:
type: integer
postCode:
type: string
postId:
type: integer
postName:
type: string
remark:
type: string
sort:
type: integer
status:
type: integer
updateBy:
type: integer
type: object
dto.SysPostUpdateReq:
properties:
createBy:
type: integer
postCode:
type: string
postId:
type: integer
postName:
type: string
remark:
type: string
sort:
type: integer
status:
type: integer
updateBy:
type: integer
type: object
dto.SysRoleDeleteReq:
properties:
ids:
items:
type: integer
type: array
type: object
dto.SysRoleInsertReq:
properties:
admin:
type: boolean
createBy:
type: integer
dataScope:
type: string
deptIds:
items:
type: integer
type: array
flag:
description: 标记
type: string
menuIds:
items:
type: integer
type: array
remark:
description: 备注
type: string
roleId:
description: 角色编码
type: integer
roleKey:
description: 角色代码
type: string
roleName:
description: 角色名称
type: string
roleSort:
description: 角色排序
type: integer
status:
description: 状态 1禁用 2正常
type: string
sysDept:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysDept'
type: array
sysMenu:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysMenu'
type: array
updateBy:
type: integer
type: object
dto.SysRoleUpdateReq:
properties:
admin:
type: boolean
createBy:
type: integer
dataScope:
type: string
deptIds:
items:
type: integer
type: array
flag:
description: 标记
type: string
menuIds:
items:
type: integer
type: array
remark:
description: 备注
type: string
roleId:
description: 角色编码
type: integer
roleKey:
description: 角色代码
type: string
roleName:
description: 角色名称
type: string
roleSort:
description: 角色排序
type: integer
status:
description: 状态
type: string
sysDept:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysDept'
type: array
sysMenu:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysMenu'
type: array
updateBy:
type: integer
type: object
dto.SysUserInsertReq:
properties:
avatar:
type: string
createBy:
type: integer
deptId:
type: integer
email:
type: string
nickName:
type: string
password:
type: string
phone:
type: string
postId:
type: integer
remark:
type: string
roleId:
type: integer
sex:
type: string
status:
default: "1"
type: string
updateBy:
type: integer
userId:
description: 用户ID
type: integer
username:
type: string
type: object
dto.SysUserUpdateReq:
properties:
avatar:
type: string
createBy:
type: integer
deptId:
type: integer
email:
type: string
nickName:
type: string
phone:
type: string
postId:
type: integer
remark:
type: string
roleId:
type: integer
sex:
type: string
status:
default: "1"
type: string
updateBy:
type: integer
userId:
description: 用户ID
type: integer
username:
type: string
type: object
dto.UpdateStatusReq:
properties:
createBy:
type: integer
roleId:
description: 角色编码
type: integer
status:
description: 状态
type: string
updateBy:
type: integer
type: object
dto.UpdateSysUserStatusReq:
properties:
createBy:
type: integer
status:
type: string
updateBy:
type: integer
userId:
description: 用户ID
type: integer
type: object
go-admin_app_admin_models.SysApi:
properties:
action:
type: string
createBy:
type: integer
createdAt:
type: string
handle:
type: string
id:
type: integer
path:
type: string
title:
type: string
type:
type: string
updateBy:
type: integer
updatedAt:
type: string
type: object
go-admin_app_admin_models.SysConfig:
properties:
configKey:
type: string
configName:
type: string
configType:
type: string
configValue:
type: string
createBy:
type: integer
createdAt:
type: string
id:
type: integer
isFrontend:
type: string
remark:
type: string
updateBy:
type: integer
updatedAt:
type: string
type: object
go-admin_app_admin_models.SysDept:
properties:
children:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysDept'
type: array
createBy:
type: integer
createdAt:
type: string
dataScope:
type: string
deptId:
description: 部门编码
type: integer
deptName:
description: 部门名称
type: string
deptPath:
type: string
email:
description: 邮箱
type: string
leader:
description: 负责人
type: string
params:
type: string
parentId:
description: 上级部门
type: integer
phone:
description: 手机
type: string
sort:
description: 排序
type: integer
status:
description: 状态
type: integer
updateBy:
type: integer
updatedAt:
type: string
type: object
go-admin_app_admin_models.SysMenu:
properties:
action:
type: string
apis:
items:
type: integer
type: array
breadcrumb:
type: string
children:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysMenu'
type: array
component:
type: string
createBy:
type: integer
createdAt:
type: string
dataScope:
type: string
icon:
type: string
is_select:
type: boolean
isFrame:
type: string
menuId:
type: integer
menuName:
type: string
menuType:
type: string
noCache:
type: boolean
params:
type: string
parentId:
type: integer
path:
type: string
paths:
type: string
permission:
type: string
roleId:
type: integer
sort:
type: integer
sysApi:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: array
title:
type: string
updateBy:
type: integer
updatedAt:
type: string
visible:
type: string
type: object
handler.Login:
properties:
code:
type: string
password:
type: string
username:
type: string
uuid:
type: string
required:
- code
- password
- username
- uuid
type: object
models.Action:
properties:
orderApp:
description: 订购包名
type: string
orderChannel:
description: 订购渠道
type: string
type: object
models.AddChannelReq:
properties:
main_channel_code:
description: 主渠道编码 (必填)
type: string
product_id:
description: 产品ID (必填)
type: integer
remarks:
description: 备注 (非必填)
type: string
status:
description: '状态 (2: 停用, 1: 启用) (必填)'
type: integer
sub_channel_code:
description: 子渠道编码 (必填)
type: string
subscribe_url:
description: 订购成功通知接口url (非必填)
type: string
unsubscribe_url:
description: 退订通知接口url (非必填)
type: string
required:
- main_channel_code
- product_id
- status
- sub_channel_code
type: object
models.AddChannelResp:
properties:
channel_id:
description: 创建的渠道ID
type: integer
type: object
models.AddProductReq:
properties:
billing_point_id:
description: 计费点ID
type: integer
channel_api_id:
description: 渠道ID接口用
type: string
channel_code:
description: 渠道编码
type: string
name:
description: 产品名称
type: string
official_page:
description: 官方落地页
type: string
product_api_id:
description: 产品ID接口用
type: string
sku_name:
description: SKU名称
type: string
unique_code:
description: 产品唯一标识编码
type: string
required:
- billing_point_id
- channel_api_id
- channel_code
- name
- sku_name
- unique_code
type: object
models.AddProductResp:
properties:
id:
description: 新增产品的ID
type: integer
type: object
models.ChannelData:
properties:
channel_code:
description: 渠道编码
type: string
type: object
models.ChannelListReq:
properties:
is_export:
description: 1-导出
type: integer
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
type: object
models.ChannelListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgChannel'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.CheckOrderReq:
properties:
outTradeNo:
description: 自定义订单号
type: string
required:
- outTradeNo
type: object
models.CheckOrderReqEx:
properties:
linkId:
type: string
type: object
models.CheckOrderResp:
properties:
code:
description: -1已退订0:未退订404:订单记录不存在
type: string
message:
type: string
requestId:
type: string
type: object
models.DailyData:
properties:
date:
description: 日期
type: string
new_user_count:
description: 新增用户数
type: integer
unsubscribe_rate:
description: 退订率
type: string
unsubscribe_within_one_hour_rate:
description: 1小时内退订率
type: string
unsubscribed_user_count:
description: 退订用户数
type: integer
unsubscribed_within_one_hour:
description: 1小时内退订用户数
type: integer
type: object
models.HistoricalSummaryListReq:
properties:
channel:
description: 渠道号
type: string
end_time:
description: 结束时间 xxxx-xx-xx
type: string
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
skuCode:
description: 产品编号
type: integer
start_time:
description: 开始时间 xxxx-xx-xx
type: string
type: object
models.HistoricalSummaryListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgHistoricalSummary'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.HomepageDataSummaryReq:
properties:
channel:
description: 渠道名称
type: string
end_time:
description: 查询结束时间
type: string
sku_code:
description: 产品编号
type: string
start_time:
description: 查询开始时间
type: string
type: object
models.HomepageDataSummaryResp:
properties:
daily_data:
description: 每天的数据列表
items:
$ref: '#/definitions/models.DailyData'
type: array
summary:
allOf:
- $ref: '#/definitions/models.SummaryData'
description: 汇总数据
type: object
models.MgChannel:
properties:
createdAt:
type: string
id:
type: integer
main_channel_code:
description: 主渠道编码
type: string
product_id:
description: 产品ID
type: integer
remarks:
description: 备注
type: string
status:
description: '状态 (0: 停用, 1: 启用)'
type: integer
sub_channel_code:
description: 子渠道编码
type: string
subscribe_url:
description: 订购成功通知接口url
type: string
unsubscribe_url:
description: 退订通知接口url
type: string
type: object
models.MgHistoricalSummary:
properties:
channel_code:
description: 渠道编码
type: string
date:
description: 日期
type: string
new_user_count:
description: 新用户数
type: integer
new_user_unsub_on_day:
description: 当日新用户退订数
type: integer
new_user_unsub_on_day_rate:
description: 当日新用户退订率
type: string
new_user_unsub_within_hour:
description: 当日新用户退订数1小时以内
type: integer
new_user_unsub_within_hour_rate:
description: 当日新用户退订率1小时以内
type: string
product_id:
description: 产品ID
type: integer
submission_count:
description: 提交数
type: integer
type: object
models.MgOrder:
properties:
channel_code:
description: 渠道编码
type: string
channel_trade_no:
description: 渠道订单号
type: string
createdAt:
type: string
external_order_id:
description: 外部平台订单号(如咪咕等)
type: string
id:
type: integer
is_one_hour_cancel:
description: 是否1小时内退订 1-是 其他-否
type: integer
order_serial:
description: 订单流水号
type: string
phone_number:
description: 手机号
type: string
product_id:
description: 产品ID
type: integer
sm4_phone_number:
description: SM4加密手机号
type: string
state:
description: 用户订阅状态 1-订阅成功 2-已取消订阅
type: integer
subscribe_time:
description: 订阅时间
type: string
unsubscribe_time:
description: 取消订阅时间
type: string
type: object
models.MgProduct:
properties:
billing_point_id:
description: 计费点ID
type: integer
channel_api_id:
description: 渠道ID接口用
type: string
channel_code:
description: 渠道编码
type: string
createdAt:
type: string
id:
type: integer
name:
description: 产品名称
type: string
official_page:
description: 官方落地页
type: string
product_api_id:
description: 产品ID接口用
type: string
sku_name:
description: SKU名称
type: string
unique_code:
description: 产品唯一标识编码
type: string
type: object
models.MgRealtimeSummary:
properties:
channel_code:
description: 渠道编码
type: string
new_user_count:
description: 新用户数
type: integer
new_user_unsub_on_day:
description: 当日新用户退订数
type: integer
new_user_unsub_on_day_rate:
description: 当日新用户退订率
type: string
new_user_unsub_within_hour:
description: 当日新用户退订数1小时以内
type: integer
new_user_unsub_within_hour_rate:
description: 当日新用户退订率1小时以内
type: string
product_id:
description: 产品ID
type: integer
submission_count:
description: 提交数
type: integer
type: object
models.MgTransactionLog:
properties:
channel_code:
description: 渠道编码
type: string
channel_trade_no:
description: 渠道订单号
type: string
createdAt:
type: string
id:
type: integer
link_id:
description: linkId咪咕订单号
type: string
order_time:
description: 订单时间
type: string
out_trade_no:
description: 平台订单号
type: string
phone_number:
description: 手机号
type: string
product_id:
description: 产品ID
type: integer
province:
description: 省份
type: string
reason:
description: 交易失败原因
type: string
result:
description: 交易结果
type: string
verification_code:
description: 验证码
type: string
type: object
models.MgUserRetention:
properties:
channel_code:
description: 渠道编码
type: string
new_user_count:
description: 新增用户数
type: integer
product_id:
description: 产品ID
type: integer
retained_user_count:
description: 留存用户数
type: integer
retention_month:
description: 留存月份格式YYYY-MM
type: string
retention_rate:
description: 留存率(以百分比形式存储)
type: string
type: object
models.NewSendDataReq:
properties:
cert_list:
description: 证书列表1-电工证2-焊工证3-叉车证4-制冷与空调作业证5-高空作业证6-危化品作业证7-安全员证8-其他工种上岗证
items:
type: integer
type: array
data:
description: 其他选择内容
name:
description: 姓名
type: string
tel:
description: 电话
type: string
type:
description: 广告页类型 1-八大员2-旅游
type: integer
url:
description: 页面url路径
type: string
required:
- name
- tel
- type
- url
type: object
models.OppoSendDataResp:
properties:
code:
type: integer
msg:
type: string
type: object
models.OrderListReq:
properties:
channel:
description: 渠道号
type: string
channelTradeNo:
description: 渠道订单号
type: string
end_time:
description: 结束时间
type: string
is_export:
description: 1-导出
type: integer
order_serial:
description: 订单流水号
type: string
outTradeNo:
description: 外部订单号
type: string
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: integer
sm4_phone_number:
description: SM4加密手机号
type: string
start_time:
description: 开始时间
type: string
state:
description: 退订状态 0-查所有 1-未退订 2-已退订
type: integer
type: object
models.OrderListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgOrder'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.Package:
properties:
appChannel:
type: string
expireTime:
type: string
isUnsub:
type: integer
monthlyContinuous:
type: integer
packageId:
type: string
packageName:
type: string
subTime:
type: string
unsubTime:
type: string
type: object
models.ProductListReq:
properties:
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
type: object
models.ProductListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgProduct'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.QueryRightsInfoReq:
properties:
appChannelList:
description: 渠道号
items:
type: string
type: array
mobile:
description: 手机号sm4加密
type: string
packageId:
description: 计费点id
type: string
required:
- appChannelList
- mobile
type: object
models.QueryRightsInfoReqEx:
properties:
channel:
description: 渠道号
type: string
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: string
required:
- channel
- phone
- skuCode
type: object
models.QueryRightsInfoResp:
properties:
message:
type: string
resultData:
items:
$ref: '#/definitions/models.Package'
type: array
returnCode:
type: string
serverTime:
type: integer
type: object
models.RealtimeSummaryListReq:
properties:
channel:
description: 渠道号
type: string
end_time:
description: 结束时间 23:59:59
type: string
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
skuCode:
description: 产品编号
type: integer
start_time:
description: 开始时间 00:00:00
type: string
type: object
models.RealtimeSummaryListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgRealtimeSummary'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.SendCaptchaReq:
properties:
channel:
description: 渠道号
type: string
outTradeNo:
description: 自定义订单号
type: string
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: string
userAction:
allOf:
- $ref: '#/definitions/models.Action'
description: 用户操作记录
required:
- channel
- phone
- skuCode
type: object
models.SendCaptchaReqEx:
properties:
channel:
description: 渠道号
type: string
outTradeNo:
description: 自定义订单号
type: string
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: string
required:
- channel
- phone
- skuCode
type: object
models.SendCaptchaResp:
properties:
linkId:
type: string
type: object
models.SubmitOrderReq:
properties:
channel:
description: 渠道号
type: string
linkId:
description: 验证码接口返回的linkId
type: string
outTradeNo:
description: 自定义订单号
type: string
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: string
smsCode:
description: 验证码
type: string
userAction:
allOf:
- $ref: '#/definitions/models.Action'
description: 用户操作记录
required:
- channel
- linkId
- phone
- skuCode
- smsCode
type: object
models.SubmitOrderReqEx:
properties:
channel:
description: 渠道号
type: string
linkId:
description: 验证码接口返回的linkId
type: string
outTradeNo:
description: 自定义订单号
type: string
phone:
description: 手机号码
type: string
skuCode:
description: 产品编号
type: string
smsCode:
description: 验证码
type: string
required:
- channel
- linkId
- phone
- skuCode
- smsCode
type: object
models.SubmitOrderResp:
properties:
linkId:
type: string
type: object
models.SummaryData:
properties:
one_hour_unsubscribe_rate:
description: 1小时退订率 (字符串,保留两位小数,如 "26.35%")
type: string
one_hour_unsubscribed_user_count:
description: 1小时内退订用户数
type: integer
retained_user_count:
description: 留存用户数
type: integer
retention_rate:
description: 留存率 (字符串,保留两位小数,如 "73.65%")
type: string
total_user_count:
description: 总用户数
type: integer
unsubscribe_rate:
description: 退订率 (字符串,保留两位小数,如 "26.35%")
type: string
unsubscribed_user_count:
description: 退订用户数
type: integer
type: object
models.SysChannelListReq:
properties:
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
type: object
models.SysChannelListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.ChannelData'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.TransactionListReq:
properties:
channel:
description: 渠道号
type: string
end_time:
description: 结束时间
type: string
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
phone:
description: 手机号码
type: string
result:
description: 交易结果
type: string
skuCode:
description: 产品编号
type: integer
start_time:
description: 开始时间
type: string
type: object
models.TransactionListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgTransactionLog'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
models.UserRetentionListReq:
properties:
channel:
description: 渠道号
type: string
page_num:
description: 页码
type: integer
page_size:
description: 每页条数
type: integer
province:
description: 省份
type: string
retention_month:
description: Date string `json:"date"` // 月用户格式YYYY-MM
type: string
skuCode:
description: 产品编号
type: string
type: object
models.UserRetentionListResp:
properties:
count:
type: integer
list:
items:
$ref: '#/definitions/models.MgUserRetention'
type: array
page_num:
type: integer
page_size:
type: integer
type: object
response.Page:
properties:
count:
type: integer
pageIndex:
type: integer
pageSize:
type: integer
type: object
response.Response:
properties:
code:
type: integer
msg:
type: string
requestId:
description: 数据集
type: string
status:
type: string
type: object
tools.Params:
properties:
treeCode:
type: string
treeName:
type: string
treeParentCode:
type: string
type: object
tools.SysColumns:
properties:
columnComment:
type: string
columnId:
type: integer
columnName:
type: string
columnType:
type: string
createBy:
type: integer
createdAt:
type: string
deletedAt:
type: string
dictType:
type: string
edit:
type: boolean
fkCol:
items:
$ref: '#/definitions/tools.SysColumns'
type: array
fkLabelId:
type: string
fkLabelName:
type: string
fkTableName:
type: string
fkTableNameClass:
type: string
fkTableNamePackage:
type: string
goField:
type: string
goType:
type: string
htmlType:
type: string
increment:
type: boolean
insert:
type: boolean
isEdit:
type: string
isIncrement:
type: string
isInsert:
type: string
isList:
type: string
isPk:
type: string
isQuery:
type: string
isRequired:
type: string
jsonField:
type: string
list:
type: string
pk:
type: boolean
query:
type: boolean
queryType:
type: string
remark:
type: string
required:
type: boolean
sort:
type: integer
superColumn:
type: boolean
tableId:
type: integer
updateBy:
type: integer
updatedAt:
type: string
usableColumn:
type: boolean
type: object
tools.SysTables:
properties:
businessName:
type: string
className:
description: 类名
type: string
columns:
items:
$ref: '#/definitions/tools.SysColumns'
type: array
createBy:
type: integer
createdAt:
type: string
crud:
type: boolean
dataScope:
type: string
deletedAt:
type: string
functionAuthor:
description: 功能作者
type: string
functionName:
description: 功能名称
type: string
isActions:
type: integer
isAuth:
type: integer
isDataScope:
type: integer
isLogicalDelete:
type: string
logicalDelete:
type: boolean
logicalDeleteColumn:
type: string
moduleFrontName:
description: 前端文件名
type: string
moduleName:
description: go文件名
type: string
options:
type: string
packageName:
description: 包名
type: string
params:
$ref: '#/definitions/tools.Params'
pkColumn:
type: string
pkGoField:
type: string
pkJsonField:
type: string
remark:
type: string
tableComment:
description: 表备注
type: string
tableId:
description: 表编码
type: integer
tableName:
description: 表名称
type: string
tplCategory:
type: string
tree:
type: boolean
treeCode:
type: string
treeName:
type: string
treeParentCode:
type: string
updateBy:
type: integer
updatedAt:
type: string
type: object
info:
contact: {}
description: |-
基于Gin + Vue + Element UI的前后端分离权限管理系统的接口文档
添加qq群: 521386980 进入技术交流群 请先star谢谢
license:
name: MIT
url: https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md
title: go-admin API
version: 2.0.0
paths:
/api/v1/admin/channel/add:
post:
consumes:
- application/json
parameters:
- description: 新增渠道
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.AddChannelReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.AddChannelResp'
summary: 新增渠道
tags:
- 2024-咪咕-管理后台
/api/v1/admin/channel/list:
post:
consumes:
- application/json
parameters:
- description: 查询渠道列表
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.ChannelListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.ChannelListResp'
summary: 查询渠道列表
tags:
- 2024-咪咕-管理后台
/api/v1/admin/historical_summary/list:
post:
consumes:
- application/json
parameters:
- description: 历史汇总查询
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.HistoricalSummaryListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.HistoricalSummaryListResp'
summary: 历史汇总查询
tags:
- 2024-咪咕-管理后台
/api/v1/admin/home/data:
post:
consumes:
- application/json
parameters:
- description: 查询首页汇总数据
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.HomepageDataSummaryReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.HomepageDataSummaryResp'
summary: 查询首页汇总数据
tags:
- 2024-咪咕-管理后台
/api/v1/admin/order/list:
post:
consumes:
- application/json
parameters:
- description: 查询订单列表
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.OrderListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.OrderListResp'
summary: 查询订单列表
tags:
- 2024-咪咕-管理后台
/api/v1/admin/product/add:
post:
consumes:
- application/json
parameters:
- description: 新增产品
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.AddProductReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.AddProductResp'
summary: 添加新产品
tags:
- 2024-咪咕-管理后台
/api/v1/admin/product/list:
post:
consumes:
- application/json
parameters:
- description: 查询权益产品
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.ProductListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.ProductListResp'
summary: 查询权益产品
tags:
- 2024-咪咕-管理后台
/api/v1/admin/realtime_summary/list:
post:
consumes:
- application/json
parameters:
- description: 当日实时汇总
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.RealtimeSummaryListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.RealtimeSummaryListResp'
summary: 当日实时汇总
tags:
- 2024-咪咕-管理后台
/api/v1/admin/sys_channel/list:
post:
consumes:
- application/json
parameters:
- description: 查询系统渠道编码
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.SysChannelListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.SysChannelListResp'
summary: 查询系统渠道编码
tags:
- 2024-咪咕-管理后台
/api/v1/admin/transaction/list:
post:
consumes:
- application/json
parameters:
- description: 查询交易流水记录
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.TransactionListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.TransactionListResp'
summary: 查询交易流水记录
tags:
- 2024-咪咕-管理后台
/api/v1/admin/user_retention/list:
post:
consumes:
- application/json
parameters:
- description: 用户留存记录
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.UserRetentionListReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.UserRetentionListResp'
summary: 用户留存记录
tags:
- 2024-咪咕-管理后台
/api/v1/app-config:
get:
description: 获取系统配置信息,主要注意这里不在验证权限
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties:
type: string
type: object
type: object
summary: 获取系统前台配置信息,主要注意这里不在验证权限
tags:
- 配置管理
/api/v1/captcha:
get:
description: 获取验证码
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
type: string
id:
type: string
msg:
type: string
type: object
summary: 获取验证码
tags:
- 登陆
/api/v1/coupon_provider/order/check:
post:
consumes:
- application/json
parameters:
- description: 查询是否已经退订接口
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.CheckOrderReqEx'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.CheckOrderResp'
summary: 查询是否已经退订接口
tags:
- 2024-咪咕(对外)-下单
/api/v1/coupon_provider/order/check_rights_info:
post:
consumes:
- application/json
parameters:
- description: 查询是否已经退订接口(咪咕)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.QueryRightsInfoReqEx'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.QueryRightsInfoResp'
summary: 查询是否已经退订接口(咪咕)
tags:
- 2024-咪咕(对外)-下单
/api/v1/coupon_provider/send_captcha:
post:
consumes:
- application/json
parameters:
- description: 下单接口(下发验证码)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.SendCaptchaReqEx'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.SendCaptchaResp'
summary: 下单接口(下发验证码)
tags:
- 2024-咪咕(对外)-下单
/api/v1/coupon_provider/submit_order:
post:
consumes:
- application/json
parameters:
- description: 提交接口(提交验证码)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.SubmitOrderReqEx'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.SubmitOrderResp'
summary: 提交接口(提交验证码)
tags:
- 2024-咪咕(对外)-下单
/api/v1/db/columns/page:
get:
description: 数据库表列分页列表 / database table column page list
parameters:
- description: tableName / 数据表名称
in: query
name: tableName
type: string
- description: pageSize / 页条数
in: query
name: pageSize
type: integer
- description: pageIndex / 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
summary: 分页列表数据 / page list data
tags:
- 工具 / 生成工具
/api/v1/db/tables/page:
get:
description: 数据库表分页列表 / database table page list
parameters:
- description: tableName / 数据表名称
in: query
name: tableName
type: string
- description: pageSize / 页条数
in: query
name: pageSize
type: integer
- description: pageIndex / 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
summary: 分页列表数据 / page list data
tags:
- 工具 / 生成工具
/api/v1/dept:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDeptDeleteReq'
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
security:
- Bearer: []
summary: 删除部门
tags:
- 部门
get:
description: 分页列表
parameters:
- description: deptName
in: query
name: deptName
type: string
- description: deptId
in: query
name: deptId
type: string
- description: position
in: query
name: position
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 分页部门列表数据
tags:
- 部门
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDeptInsertReq'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加部门
tags:
- 部门
/api/v1/dept/{deptId}:
get:
description: 获取JSON
parameters:
- description: deptId
in: path
name: deptId
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取部门数据
tags:
- 部门
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: id
in: path
name: id
required: true
type: integer
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDeptUpdateReq'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改部门
tags:
- 部门
/api/v1/dict-data/option-select:
get:
description: 数据字典根据key获取
parameters:
- description: dictType
in: query
name: dictType
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
items:
$ref: '#/definitions/dto.SysDictDataGetAllResp'
type: array
type: object
security:
- Bearer: []
summary: 数据字典根据key获取
tags:
- 字典数据
/api/v1/dict/data:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: dictCode
required: true
schema:
$ref: '#/definitions/dto.SysDictDataDeleteReq'
responses:
"200":
description: '{"code": 200, "message": "删除成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除字典数据
tags:
- 字典数据
get:
description: 获取JSON
parameters:
- description: status
in: query
name: status
type: string
- description: dictCode
in: query
name: dictCode
type: string
- description: dictType
in: query
name: dictType
type: string
- description: 页条数
in: query
name: pageSize
type: integer
- description: 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 字典数据列表
tags:
- 字典数据
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDictDataInsertReq'
responses:
"200":
description: '{"code": 200, "message": "添加成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 添加字典数据
tags:
- 字典数据
/api/v1/dict/data/{dictCode}:
get:
description: 获取JSON
parameters:
- description: 字典编码
in: path
name: dictCode
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 通过编码获取字典数据
tags:
- 字典数据
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDictDataUpdateReq'
responses:
"200":
description: '{"code": 200, "message": "修改成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改字典数据
tags:
- 字典数据
/api/v1/dict/type:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: dictCode
required: true
schema:
$ref: '#/definitions/dto.SysDictTypeDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除字典类型
tags:
- 字典类型
get:
description: 获取JSON
parameters:
- description: dictName
in: query
name: dictName
type: string
- description: dictId
in: query
name: dictId
type: string
- description: dictType
in: query
name: dictType
type: string
- description: 页条数
in: query
name: pageSize
type: integer
- description: 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 字典类型列表数据
tags:
- 字典类型
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDictTypeInsertReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 添加字典类型
tags:
- 字典类型
/api/v1/dict/type-option-select:
get:
description: 获取JSON
parameters:
- description: dictName
in: query
name: dictName
type: string
- description: dictId
in: query
name: dictId
type: string
- description: dictType
in: query
name: dictType
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 字典类型全部数据 代码生成使用接口
tags:
- 字典类型
/api/v1/dict/type/{dictId}:
get:
description: 获取JSON
parameters:
- description: 字典类型编码
in: path
name: dictId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 字典类型通过字典id获取
tags:
- 字典类型
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysDictTypeUpdateReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改字典类型
tags:
- 字典类型
/api/v1/getinfo:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取个人信息
tags:
- 个人中心
/api/v1/login:
post:
consumes:
- application/json
description: |-
获取token
LoginHandler can be used by clients to get a jwt token.
Payload needs to be json in the form of {"username": "USERNAME", "password": "PASSWORD"}.
Reply will be of the form {"token": "TOKEN"}.
dev modeIt should be noted that all fields cannot be empty, and a value of 0 can be passed in addition to the account password
注意开发模式需要注意全部字段不能为空账号密码外可以传入0值
parameters:
- description: account
in: body
name: account
required: true
schema:
$ref: '#/definitions/handler.Login'
responses:
"200":
description: '{"code": 200, "expire": "2019-08-07T12:45:48+08:00", "token":
".eyJleHAiOjE1NjUxNTMxNDgsImlkIjoiYWRtaW4iLCJvcmlnX2lhdCI6MTU2NTE0OTU0OH0.-zvzHvbg0A"
}'
schema:
type: string
summary: 登陆
tags:
- 登陆
/api/v1/menu:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysMenuDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除菜单
tags:
- 菜单
get:
description: 获取JSON
parameters:
- description: menuName
in: query
name: menuName
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: Menu列表数据
tags:
- 菜单
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysMenuInsertReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 创建菜单
tags:
- 菜单
/api/v1/menu/{id}:
get:
description: 获取JSON
parameters:
- description: id
in: path
name: id
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: Menu详情数据
tags:
- 菜单
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: id
in: path
name: id
required: true
type: integer
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysMenuUpdateReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改菜单
tags:
- 菜单
/api/v1/menuTreeselect/{roleId}:
get:
consumes:
- application/json
description: 获取JSON
parameters:
- description: roleId
in: path
name: roleId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 角色修改使用的菜单列表
tags:
- 菜单
/api/v1/menurole:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 根据登录角色名称获取菜单列表数据(左菜单使用)
tags:
- 菜单
/api/v1/migu/order/check:
post:
consumes:
- application/json
parameters:
- description: 查询是否已经退订接口
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.CheckOrderReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.CheckOrderResp'
summary: 查询是否已经退订接口
tags:
- 2024-咪咕-下单
/api/v1/migu/order/check_rights_info:
post:
consumes:
- application/json
parameters:
- description: 查询是否已经退订接口(咪咕)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.QueryRightsInfoReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.QueryRightsInfoResp'
summary: 查询是否已经退订接口(咪咕)
tags:
- 2024-咪咕-下单
/api/v1/migu/send_captcha:
post:
consumes:
- application/json
parameters:
- description: 下单接口(下发验证码)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.SendCaptchaReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.SendCaptchaResp'
summary: 下单接口(下发验证码)
tags:
- 2024-咪咕-下单
/api/v1/migu/submit_order:
post:
consumes:
- application/json
parameters:
- description: 提交接口(提交验证码)
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.SubmitOrderReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.SubmitOrderResp'
summary: 提交接口(提交验证码)
tags:
- 2024-咪咕-下单
/api/v1/notice/subscribe:
get:
consumes:
- application/json
parameters:
- description: 订购成功通知接口
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.NewSendDataReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.OppoSendDataResp'
summary: 订购成功通知接口
tags:
- 2024-咪咕-回调
/api/v1/notice/unsubscribe:
get:
consumes:
- application/json
parameters:
- description: 退订通知接口
in: body
name: request
required: true
schema:
$ref: '#/definitions/models.NewSendDataReq'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.OppoSendDataResp'
summary: 退订通知接口
tags:
- 2024-咪咕-回调
/api/v1/post:
delete:
description: 删除数据
parameters:
- description: 请求参数
in: body
name: id
required: true
schema:
$ref: '#/definitions/dto.SysPostDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除岗位
tags:
- 岗位
get:
description: 获取JSON
parameters:
- description: postName
in: query
name: postName
type: string
- description: postCode
in: query
name: postCode
type: string
- description: postId
in: query
name: postId
type: string
- description: status
in: query
name: status
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 岗位列表数据
tags:
- 岗位
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysPostInsertReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 添加岗位
tags:
- 岗位
/api/v1/post/{id}:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysPostUpdateReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改岗位
tags:
- 岗位
/api/v1/post/{postId}:
get:
description: 获取JSON
parameters:
- description: 编码
in: path
name: id
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取岗位信息
tags:
- 岗位
/api/v1/public/uploadFile:
post:
consumes:
- multipart/form-data
description: 获取JSON
parameters:
- description: type
in: query
name: type
required: true
type: string
- description: file
in: formData
name: file
required: true
type: file
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 上传图片
tags:
- 公共接口
/api/v1/role:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysRoleDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除用户角色
tags:
- 角色/Role
get:
description: Get JSON
parameters:
- description: roleName
in: query
name: roleName
type: string
- description: status
in: query
name: status
type: string
- description: roleKey
in: query
name: roleKey
type: string
- description: 页条数
in: query
name: pageSize
type: integer
- description: 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 角色列表数据
tags:
- 角色/Role
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: data
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysRoleInsertReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 创建角色
tags:
- 角色/Role
/api/v1/role-status/{id}:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.RoleDataScopeReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 更新角色数据权限
tags:
- 角色/Role
/api/v1/role/{id}:
get:
description: 获取JSON
parameters:
- description: roleId
in: path
name: roleId
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取Role数据
tags:
- 角色/Role
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysRoleUpdateReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改用户角色
tags:
- 角色/Role
/api/v1/server-monitor:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 系统信息
tags:
- 系统信息
/api/v1/set-config:
get:
consumes:
- application/json
description: 界面操作设置配置值的获取
responses:
"200":
description: '{"code": 200, "message": "修改成功"}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
additionalProperties: true
type: object
type: object
security:
- Bearer: []
summary: 获取配置
tags:
- 配置管理
put:
consumes:
- application/json
description: 界面操作设置配置值
parameters:
- description: body
in: body
name: data
required: true
schema:
items:
$ref: '#/definitions/dto.GetSetSysConfigReq'
type: array
responses:
"200":
description: '{"code": 200, "message": "修改成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 设置配置
tags:
- 配置管理
/api/v1/sys-api:
delete:
description: 删除接口管理
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysApiDeleteReq'
responses:
"200":
description: '{"code": 200, "message": "删除成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除接口管理
tags:
- 接口管理
get:
description: 获取接口管理列表
parameters:
- description: 名称
in: query
name: name
type: string
- description: 标题
in: query
name: title
type: string
- description: 地址
in: query
name: path
type: string
- description: 类型
in: query
name: action
type: string
- description: 页条数
in: query
name: pageSize
type: integer
- description: 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
allOf:
- $ref: '#/definitions/response.Page'
- properties:
list:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: array
type: object
type: object
security:
- Bearer: []
summary: 获取接口管理列表
tags:
- 接口管理
/api/v1/sys-api/{id}:
get:
description: 获取接口管理
parameters:
- description: id
in: path
name: id
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: object
security:
- Bearer: []
summary: 获取接口管理
tags:
- 接口管理
put:
consumes:
- application/json
description: 修改接口管理
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysApiUpdateReq'
responses:
"200":
description: '{"code": 200, "message": "修改成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改接口管理
tags:
- 接口管理
/api/v1/sys-config:
delete:
description: 删除配置管理
parameters:
- description: ids
in: body
name: ids
schema:
items:
type: integer
type: array
responses:
"200":
description: '{"code": 200, "message": "删除成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除配置管理
tags:
- 配置管理
get:
description: 获取配置管理列表
parameters:
- description: 名称
in: query
name: configName
type: string
- description: key
in: query
name: configKey
type: string
- description: 类型
in: query
name: configType
type: string
- description: 是否前端
in: query
name: isFrontend
type: integer
- description: 页条数
in: query
name: pageSize
type: integer
- description: 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
allOf:
- $ref: '#/definitions/response.Page'
- properties:
list:
items:
$ref: '#/definitions/go-admin_app_admin_models.SysApi'
type: array
type: object
type: object
security:
- Bearer: []
summary: 获取配置管理列表
tags:
- 配置管理
post:
consumes:
- application/json
description: 创建配置管理
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysConfigControl'
responses:
"200":
description: '{"code": 200, "message": "创建成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 创建配置管理
tags:
- 配置管理
/api/v1/sys-config/{id}:
get:
description: 根据Key获取SysConfig的Service
parameters:
- description: configKey
in: path
name: configKey
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
allOf:
- $ref: '#/definitions/response.Response'
- properties:
data:
$ref: '#/definitions/dto.SysConfigByKeyReq'
type: object
security:
- Bearer: []
summary: 根据Key获取SysConfig的Service
tags:
- 配置管理
put:
consumes:
- application/json
description: 修改配置管理
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysConfigControl'
responses:
"200":
description: '{"code": 200, "message": "修改成功"}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改配置管理
tags:
- 配置管理
/api/v1/sys-login-log:
delete:
description: 登录日志删除
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysLoginLogDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 登录日志删除
tags:
- 登录日志
get:
description: 获取JSON
parameters:
- description: 用户名
in: query
name: username
type: string
- description: ip地址
in: query
name: ipaddr
type: string
- description: 归属地
in: query
name: loginLocation
type: string
- description: 状态
in: query
name: status
type: string
- description: 开始时间
in: query
name: beginTime
type: string
- description: 结束时间
in: query
name: endTime
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 登录日志列表
tags:
- 登录日志
/api/v1/sys-login-log/{id}:
get:
description: 获取JSON
parameters:
- description: id
in: path
name: id
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 登录日志通过id获取
tags:
- 登录日志
/api/v1/sys-opera-log:
delete:
description: 删除数据
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysOperaLogDeleteReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除操作日志
tags:
- 操作日志
get:
description: 获取JSON
parameters:
- description: title
in: query
name: title
type: string
- description: method
in: query
name: method
type: string
- description: requestMethod
in: query
name: requestMethod
type: string
- description: operUrl
in: query
name: operUrl
type: string
- description: operIp
in: query
name: operIp
type: string
- description: status
in: query
name: status
type: string
- description: beginTime
in: query
name: beginTime
type: string
- description: endTime
in: query
name: endTime
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 操作日志列表
tags:
- 操作日志
/api/v1/sys-opera-log/{id}:
get:
description: 获取JSON
parameters:
- description: id
in: path
name: id
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 操作日志通过id获取
tags:
- 操作日志
/api/v1/sys-user:
get:
description: 获取JSON
parameters:
- description: username
in: query
name: username
type: string
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
type: string
security:
- Bearer: []
summary: 列表用户信息数据
tags:
- 用户
post:
consumes:
- application/json
description: 获取JSON
parameters:
- description: 用户数据
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysUserInsertReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 创建用户
tags:
- 用户
/api/v1/sys-user/{userId}:
delete:
description: 删除数据
parameters:
- description: userId
in: path
name: userId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 删除用户数据
tags:
- 用户
get:
description: 获取JSON
parameters:
- description: 用户编码
in: path
name: userId
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取用户
tags:
- 用户
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.SysUserUpdateReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改用户数据
tags:
- 用户
/api/v1/sys/tables/info:
post:
consumes:
- application/json
description: 添加表结构
parameters:
- description: tableName / 数据表名称
in: query
name: tables
type: string
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 添加表结构
tags:
- 工具 / 生成工具
put:
consumes:
- application/json
description: 修改表结构
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/tools.SysTables'
responses:
"200":
description: '{"code": -1, "message": "添加失败"}'
schema:
type: string
security:
- Bearer: []
summary: 修改表结构
tags:
- 工具 / 生成工具
/api/v1/sys/tables/info/{tableId}:
delete:
description: 删除表结构
parameters:
- description: tableId
in: path
name: tableId
required: true
type: integer
responses:
"200":
description: '{"code": -1, "message": "删除失败"}'
schema:
type: string
summary: 删除表结构
tags:
- 工具 / 生成工具
get:
description: 获取JSON
parameters:
- description: configKey
in: path
name: configKey
required: true
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取配置
tags:
- 工具 / 生成工具
/api/v1/sys/tables/page:
get:
description: 生成表分页列表
parameters:
- description: tableName / 数据表名称
in: query
name: tableName
type: string
- description: pageSize / 页条数
in: query
name: pageSize
type: integer
- description: pageIndex / 页码
in: query
name: pageIndex
type: integer
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
summary: 分页列表数据
tags:
- 工具 / 生成工具
/api/v1/user/avatar:
post:
consumes:
- multipart/form-data
description: 获取JSON
parameters:
- description: file
in: formData
name: file
required: true
type: file
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改头像
tags:
- 个人中心
/api/v1/user/profile:
get:
description: 获取JSON
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 获取个人中心用户
tags:
- 个人中心
/api/v1/user/pwd/reset:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.ResetSysUserPwdReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 重置用户密码
tags:
- 用户
/api/v1/user/pwd/set:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.PassWord'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改密码
tags:
- 用户
/api/v1/user/status:
put:
consumes:
- application/json
description: 获取JSON
parameters:
- description: body
in: body
name: data
required: true
schema:
$ref: '#/definitions/dto.UpdateSysUserStatusReq'
responses:
"200":
description: '{"code": 200, "data": [...]}'
schema:
$ref: '#/definitions/response.Response'
security:
- Bearer: []
summary: 修改用户状态
tags:
- 用户
/logout:
post:
consumes:
- application/json
description: 获取token
responses:
"200":
description: '{"code": 200, "msg": "成功退出系统" }'
schema:
type: string
security:
- Bearer: []
summary: 退出登录
securityDefinitions:
Bearer:
in: header
name: Authorization
type: apiKey
swagger: "2.0"