196 lines
10 KiB
Go
196 lines
10 KiB
Go
package v1
|
|
|
|
import (
|
|
"github.com/gogf/gf/v2/os/gtime"
|
|
"github.com/gogf/gf/v2/util/gmeta"
|
|
)
|
|
|
|
// ============================== 租户模块 ==============================
|
|
|
|
// TenantItem 租户行数据
|
|
// 用于租户分页列表等场景的租户基础信息
|
|
type TenantItem struct {
|
|
Id int64 `json:"id"` // 主键ID
|
|
Name string `json:"name"` // 租户名称
|
|
Code string `json:"code"` // 租户编码
|
|
Contact string `json:"contact"` // 联系人
|
|
Mobile string `json:"mobile"` // 联系电话
|
|
Email string `json:"email"` // 邮箱
|
|
Address string `json:"address"` // 地址
|
|
Logo string `json:"logo"` // Logo
|
|
Status int `json:"status"` // 状态：1-正常 2-禁用
|
|
StatusText string `json:"statusText"` // 状态文本
|
|
ExpireTime *gtime.Time `json:"expireTime"` // 过期时间
|
|
MaxUserNum int `json:"maxUserNum"` // 用户数上限（0=不限）
|
|
UserCount int `json:"userCount"` // 已用用户数
|
|
Note string `json:"note"` // 备注
|
|
CreateUser string `json:"createUser"` // 创建人
|
|
CreateTime *gtime.Time `json:"createTime"` // 创建时间
|
|
}
|
|
|
|
// TenantPageReq 租户分页请求
|
|
// 支持关键词、租户名称、租户编码、状态等条件组合查询
|
|
type TenantPageReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/tenant/page" summary:"租户分页" permission:"sys:tenant:page" log:"租户管理-查询分页记录" logType:"query"`
|
|
PageReq // 分页基础参数
|
|
Keyword string `json:"keyword" dc:"关键词（名称/编码/联系人模糊）"` // 关键词，名称、编码或联系人模糊匹配
|
|
Name string `json:"name" dc:"租户名称模糊"` // 租户名称模糊匹配
|
|
Code string `json:"code" dc:"租户编码模糊"` // 租户编码模糊匹配
|
|
Status int `json:"status" dc:"状态：1-正常 2-禁用"` // 状态
|
|
}
|
|
|
|
// TenantPageRes 租户分页结果
|
|
type TenantPageRes = PageData[TenantItem]
|
|
|
|
// TenantListReq 租户全量列表请求
|
|
type TenantListReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/tenant/list" summary:"租户列表" permission:"sys:tenant:list" log:"租户管理-查询列表" logType:"query"`
|
|
Keyword string `json:"keyword" dc:"关键词"` // 关键词
|
|
Status int `json:"status" dc:"状态"` // 状态
|
|
}
|
|
|
|
// TenantListItem 租户列表行数据
|
|
// 精简结构，仅包含列表展示所需字段
|
|
type TenantListItem struct {
|
|
Id int64 `json:"id"` // 主键ID
|
|
Name string `json:"name"` // 租户名称
|
|
Code string `json:"code"` // 租户编码
|
|
Status int `json:"status"` // 状态：1-正常 2-禁用
|
|
}
|
|
|
|
// TenantListRes 租户列表结果
|
|
type TenantListRes = []TenantListItem
|
|
|
|
// TenantDetailReq 租户详情请求
|
|
type TenantDetailReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/tenant/detail/:id" summary:"租户详情" permission:"sys:tenant:detail" log:"租户管理-查询详情" logType:"query"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"租户ID"` // 租户ID
|
|
}
|
|
|
|
// TenantDetailRes 租户详情结果
|
|
type TenantDetailRes struct {
|
|
Id int64 `json:"id"` // 主键ID
|
|
Name string `json:"name"` // 租户名称
|
|
Code string `json:"code"` // 租户编码
|
|
Contact string `json:"contact"` // 联系人
|
|
Mobile string `json:"mobile"` // 联系电话
|
|
Email string `json:"email"` // 邮箱
|
|
Address string `json:"address"` // 地址
|
|
Logo string `json:"logo"` // Logo
|
|
Status int `json:"status"` // 状态：1-正常 2-禁用
|
|
StatusText string `json:"statusText"` // 状态文本
|
|
ExpireTime *gtime.Time `json:"expireTime"` // 过期时间
|
|
MaxUserNum int `json:"maxUserNum"` // 用户数上限
|
|
Note string `json:"note"` // 备注
|
|
}
|
|
|
|
// TenantAddReq 新增租户请求
|
|
type TenantAddReq struct {
|
|
gmeta.Meta `method:"post" path:"/api/tenant/add" summary:"新增租户" permission:"sys:tenant:add" log:"租户管理-新增记录" logType:"add"`
|
|
Name string `json:"name" v:"required#请输入租户名称" dc:"租户名称"` // 租户名称
|
|
Code string `json:"code" dc:"租户编码（留空自动生成）"` // 租户编码
|
|
Contact string `json:"contact" dc:"联系人"` // 联系人
|
|
Mobile string `json:"mobile" v:"phone#手机号格式不正确" dc:"联系电话"` // 联系电话
|
|
Email string `json:"email" v:"email#邮箱格式不正确" dc:"邮箱"` // 邮箱
|
|
Address string `json:"address" dc:"地址"` // 地址
|
|
Logo string `json:"logo" dc:"Logo"` // Logo
|
|
Status int `json:"status" dc:"状态：1-正常 2-禁用"` // 状态
|
|
ExpireTime string `json:"expireTime" dc:"过期时间（Y-m-d H:i:s，留空永久）"` // 过期时间
|
|
MaxUserNum int `json:"maxUserNum" dc:"用户数上限（0=不限）"` // 用户数上限
|
|
Note string `json:"note" dc:"备注"` // 备注
|
|
}
|
|
|
|
// TenantUpdateReq 修改租户请求
|
|
type TenantUpdateReq struct {
|
|
gmeta.Meta `method:"put" path:"/api/tenant/update" summary:"修改租户" permission:"sys:tenant:update" log:"租户管理-修改记录" logType:"update"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"租户ID"` // 租户ID
|
|
Name string `json:"name" v:"required#请输入租户名称" dc:"租户名称"` // 租户名称
|
|
Code string `json:"code" dc:"租户编码（不允许修改）"` // 租户编码，不允许修改
|
|
Contact string `json:"contact" dc:"联系人"` // 联系人
|
|
Mobile string `json:"mobile" v:"phone#手机号格式不正确" dc:"联系电话"` // 联系电话
|
|
Email string `json:"email" v:"email#邮箱格式不正确" dc:"邮箱"` // 邮箱
|
|
Address string `json:"address" dc:"地址"` // 地址
|
|
Logo string `json:"logo" dc:"Logo"` // Logo
|
|
Status int `json:"status" dc:"状态"` // 状态
|
|
ExpireTime string `json:"expireTime" dc:"过期时间"` // 过期时间
|
|
MaxUserNum int `json:"maxUserNum" dc:"用户数上限"` // 用户数上限
|
|
Note string `json:"note" dc:"备注"` // 备注
|
|
}
|
|
|
|
// TenantUpdateRes 修改租户结果
|
|
type TenantUpdateRes struct{}
|
|
|
|
// TenantStatusReq 租户状态请求
|
|
type TenantStatusReq struct {
|
|
gmeta.Meta `method:"put" path:"/api/tenant/status" summary:"租户状态" permission:"sys:tenant:status" log:"租户管理-设置状态" logType:"update"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"租户ID"` // 租户ID
|
|
Status int `json:"status" v:"required#缺少状态" dc:"状态：1-正常 2-禁用"` // 状态
|
|
}
|
|
|
|
// TenantStatusRes 租户状态结果
|
|
type TenantStatusRes struct{}
|
|
|
|
// TenantDeleteReq 删除租户请求
|
|
type TenantDeleteReq struct {
|
|
gmeta.Meta `method:"delete" path:"/api/tenant/delete/:id" summary:"删除租户" permission:"sys:tenant:delete" log:"租户管理-删除记录" logType:"delete"`
|
|
Id int64 `json:"id" v:"required#缺少ID" dc:"租户ID"` // 租户ID
|
|
}
|
|
|
|
// TenantDeleteRes 删除租户结果
|
|
type TenantDeleteRes struct{}
|
|
|
|
// TenantBatchDeleteReq 批量删除租户请求
|
|
type TenantBatchDeleteReq struct {
|
|
gmeta.Meta `method:"delete" path:"/api/tenant/batchDelete" summary:"批量删除租户" permission:"sys:tenant:batchDelete" log:"租户管理-批量删除记录" logType:"delete"`
|
|
Ids []int64 `json:"ids" v:"required#请选择要删除的记录" dc:"租户ID列表"` // 租户ID列表
|
|
}
|
|
|
|
// TenantBatchDeleteRes 批量删除结果
|
|
type TenantBatchDeleteRes struct{}
|
|
|
|
// TenantAccountReq 创建租户账号请求
|
|
// 同时创建租户及其初始管理员账号
|
|
type TenantAccountReq struct {
|
|
gmeta.Meta `method:"post" path:"/api/tenant/account" summary:"创建租户账号" permission:"sys:tenant:add" log:"租户管理-创建租户账号" logType:"add"`
|
|
Name string `json:"name" v:"required#请输入租户名称" dc:"租户名称"` // 租户名称
|
|
Contact string `json:"contact" dc:"联系人"` // 联系人
|
|
Mobile string `json:"mobile" v:"phone#手机号格式不正确" dc:"联系电话"` // 联系电话
|
|
Email string `json:"email" v:"email#邮箱格式不正确" dc:"邮箱"` // 邮箱
|
|
Address string `json:"address" dc:"地址"` // 地址
|
|
ExpireTime string `json:"expireTime" dc:"过期时间"` // 过期时间
|
|
MaxUserNum int `json:"maxUserNum" dc:"用户数上限"` // 用户数上限
|
|
Note string `json:"note" dc:"备注"` // 备注
|
|
Username string `json:"username" v:"required#请输入管理员账号|length:2,30#账号长度需在2~30位" dc:"初始管理员账号"` // 初始管理员账号
|
|
Password string `json:"password" v:"required#请输入密码|length:6,32#密码长度需在6~32位" dc:"初始管理员密码"` // 初始管理员密码
|
|
Realname string `json:"realname" dc:"管理员姓名"` // 管理员姓名
|
|
}
|
|
|
|
// TenantAccountRes 创建租户账号结果
|
|
type TenantAccountRes struct {
|
|
TenantId int64 `json:"tenantId"` // 租户ID
|
|
Code string `json:"code"` // 租户编码
|
|
UserId int64 `json:"userId"` // 管理员用户ID
|
|
}
|
|
|
|
// TenantUsersReq 查询租户用户请求
|
|
type TenantUsersReq struct {
|
|
gmeta.Meta `method:"get" path:"/api/tenant/users/:tenantId" summary:"查询租户用户" permission:"sys:tenant:users" log:"租户管理-查询租户用户" logType:"query"`
|
|
TenantId int64 `json:"tenantId" v:"required#缺少租户ID" dc:"租户ID"` // 租户ID
|
|
}
|
|
|
|
// TenantUserItem 租户用户行数据
|
|
// 精简结构，仅包含租户用户列表展示所需字段
|
|
type TenantUserItem struct {
|
|
Id int64 `json:"id"` // 用户ID
|
|
Username string `json:"username"` // 用户名
|
|
Realname string `json:"realname"` // 真实姓名
|
|
Mobile string `json:"mobile"` // 手机号
|
|
Email string `json:"email"` // 邮箱
|
|
Status int `json:"status"` // 状态
|
|
}
|
|
|
|
// TenantUsersRes 查询租户用户结果
|
|
type TenantUsersRes struct {
|
|
List []TenantUserItem `json:"list"` // 租户用户列表
|
|
}
|