{ "openapi": "3.0.1", "info": { "title": "管理后台", "description": "提供管理员管理的所有功能", "contact": {}, "license": {}, "version": "1.0.0" }, "servers": [ { "url": "http://172.16.8.7:48081", "description": "Generated server url" } ], "security": [ { "Authorization": [] }, { "Authorization": [] } ], "paths": { "/open-api/system/oauth2/token": { "post": { "tags": [ "开放平台 / OAuth2.0 令牌" ], "summary": "获得访问令牌", "description": "开放平台仅支持 client_credentials 客户端模式；client_id + client_secret 通过 HTTP Basic 认证头传递", "operationId": "postAccessToken", "parameters": [ { "name": "grant_type", "in": "query", "description": "授权类型，固定为 client_credentials", "required": true, "schema": { "type": "string" }, "example": "client_credentials" }, { "name": "scope", "in": "query", "description": "授权范围，多个使用空格分隔", "required": false, "schema": { "type": "string" }, "example": "goods:detail:read" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CommonResultOAuth2OpenAccessTokenRespVO" } } } } } } }, "/open-api/system/oauth2/token/revoke": { "post": { "tags": [ "开放平台 / OAuth2.0 令牌" ], "summary": "删除访问令牌", "operationId": "revokeToken", "parameters": [ { "name": "token", "in": "query", "description": "访问令牌", "required": true, "schema": { "type": "string" }, "example": "biu" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CommonResultBoolean" } } } } } } } }, "components": { "schemas": { "CommonResultString": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "string" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultOAuth2AccessTokenRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/OAuth2AccessTokenRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OAuth2AccessTokenRespDTO": { "required": [ "accessToken", "expiresTime", "refreshToken", "userId", "userType" ], "type": "object", "properties": { "accessToken": { "type": "string", "description": "访问令牌", "example": "tudou" }, "refreshToken": { "type": "string", "description": "刷新令牌", "example": "haha" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 10 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 1 }, "expiresTime": { "type": "string", "description": "过期时间", "format": "date-time" } }, "description": "RPC 服务 - OAuth2 访问令牌的信息 Response DTO" }, "SmsCodeUseReqDTO": { "required": [ "code", "mobile", "scene", "usedIp" ], "type": "object", "properties": { "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "验证码", "example": "1024" }, "usedIp": { "type": "string", "description": "发送 IP", "example": "10.20.30.40" } }, "description": "RPC 服务 - 短信验证码的使用 Request DTO" }, "CommonResultBoolean": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "boolean" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailCodeUseReqDTO": { "required": [ "code", "mail", "scene", "usedIp" ], "type": "object", "properties": { "mail": { "type": "string", "description": "邮箱号", "example": "15601691300@163.com" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "验证码", "example": "1024" }, "usedIp": { "type": "string", "description": "发送 IP", "example": "10.20.30.40" } }, "description": "RPC 服务 - 短信验证码的使用 Request DTO" }, "UserSaveReqVO": { "required": [ "name", "nickname", "password", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "username": { "maxLength": 30, "minLength": 4, "pattern": "^[a-zA-Z0-9]{4,30}$", "type": "string", "description": "用户账号", "example": "todo" }, "nickname": { "maxLength": 30, "minLength": 0, "type": "string", "description": "用户昵称", "example": "芋艿" }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "description": "用户真实姓名", "example": "芋艿" }, "remark": { "type": "string", "description": "备注", "example": "我是一个用户" }, "deptId": { "type": "integer", "description": "部门ID", "format": "int64" }, "postIds": { "uniqueItems": true, "type": "array", "description": "岗位编号数组", "example": 1, "items": { "type": "integer", "description": "岗位编号数组", "format": "int64", "example": 1 } }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xxx.png" }, "password": { "type": "string", "description": "密码", "example": "123456" } }, "description": "管理后台 - 用户创建/修改 Request VO" }, "UserUpdateStatusReqVO": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "status": { "type": "integer", "description": "状态，见 CommonStatusEnum 枚举", "format": "int32", "example": 1 } }, "description": "管理后台 - 用户更新状态 Request VO" }, "UserUpdatePasswordReqVO": { "required": [ "id", "password" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "password": { "type": "string", "description": "密码", "example": "123456" } }, "description": "管理后台 - 用户更新密码 Request VO" }, "UserProfileUpdateReqVO": { "required": [ "nickname" ], "type": "object", "properties": { "nickname": { "maxLength": 30, "minLength": 0, "type": "string", "description": "用户昵称", "example": "芋艿" }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 用户个人信息更新 Request VO" }, "UserProfileUpdatePasswordReqVO": { "required": [ "newPassword", "oldPassword" ], "type": "object", "properties": { "oldPassword": { "type": "string", "description": "旧密码", "example": "123456" }, "newPassword": { "type": "string", "description": "新密码", "example": "654321" } }, "description": "管理后台 - 用户个人中心更新密码 Request VO" }, "TenantSaveReqVO": { "required": [ "accountCount", "contactName", "expireTime", "name", "packageId", "password", "status", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "租户编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "租户名", "example": "芋道" }, "contactName": { "type": "string", "description": "联系人", "example": "芋艿" }, "contactMobile": { "type": "string", "description": "联系手机", "example": "15601691300" }, "status": { "type": "integer", "description": "租户状态", "format": "int32", "example": 1 }, "website": { "type": "string", "description": "绑定域名", "example": "https://www.iocoder.cn" }, "packageId": { "type": "integer", "description": "租户套餐编号", "format": "int64", "example": 1024 }, "expireTime": { "type": "string", "description": "过期时间", "format": "date-time" }, "accountCount": { "type": "integer", "description": "账号数量", "format": "int32", "example": 1024 }, "username": { "maxLength": 30, "minLength": 4, "pattern": "^[a-zA-Z0-9]{4,30}$", "type": "string", "description": "用户账号", "example": "todo" }, "password": { "type": "string", "description": "密码", "example": "123456" } }, "description": "管理后台 - 租户创建/修改 Request VO" }, "TenantPackageSaveReqVO": { "required": [ "menuIds", "name", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "套餐编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "套餐名", "example": "VIP" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "好" }, "menuIds": { "uniqueItems": true, "type": "array", "description": "关联的菜单编号", "items": { "type": "integer", "description": "关联的菜单编号", "format": "int64" } } }, "description": "管理后台 - 租户套餐创建/修改 Request VO" }, "SysShortLinkRecordUpdateReqVO": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "数据id", "format": "int64", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "更新后的备注" }, "groupId": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 } }, "description": "管理后台 - 短链接记录更新 Request VO" }, "SupportInfoSaveReqVO": { "required": [ "classifyId", "content", "hot", "id", "language", "status", "terminalType", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 24031 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "24031" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "classifyId": { "type": "integer", "description": "分类id", "format": "int64", "example": 22436 }, "classifyUuid": { "type": "string", "description": "分类uuid", "nullable": true, "example": "22436" }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "terminalType": { "type": "integer", "description": "终端类型21:PC 31:APP", "format": "int32", "example": 2 }, "sort": { "type": "integer", "description": "排序-升序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1关闭）", "format": "int32", "example": 2 }, "hot": { "type": "boolean", "description": "是否热门问题", "example": false } }, "description": "管理后台 - 帮助中心信息新增/修改 Request VO" }, "SocialClientSaveReqVO": { "required": [ "agentId", "clientId", "clientSecret", "name", "socialType", "status", "userType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 27162 }, "name": { "type": "string", "description": "应用名", "example": "todo商城" }, "socialType": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 31 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 2 }, "clientId": { "type": "string", "description": "客户端编号", "example": "wwd411c69a39ad2e54" }, "clientSecret": { "type": "string", "description": "客户端密钥", "example": "peter" }, "agentId": { "type": "string", "description": "授权方的网页应用编号", "example": "2000045" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 } }, "description": "管理后台 - 社交客户端创建/修改 Request VO" }, "SmsTemplateSaveReqVO": { "required": [ "apiTemplateId", "channelId", "code", "content", "name", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "type": { "type": "integer", "description": "短信类型，参见 SmsTemplateTypeEnum 枚举类", "format": "int32", "example": 1 }, "status": { "type": "integer", "description": "开启状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "模板编码", "example": "test_01" }, "name": { "type": "string", "description": "模板名称", "example": "todo" }, "content": { "type": "string", "description": "模板内容", "example": "你好，{name}。你长的太{like}啦！" }, "remark": { "type": "string", "description": "备注", "example": "哈哈哈" }, "apiTemplateId": { "type": "string", "description": "短信 API 的模板编号", "example": "4383920" }, "channelId": { "type": "integer", "description": "短信渠道编号", "format": "int64", "example": 10 } }, "description": "管理后台 - 短信模板创建/修改 Request VO" }, "SmsChannelSaveReqVO": { "required": [ "apiKey", "code", "signature", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "signature": { "type": "string", "description": "短信签名", "example": "芋道源码" }, "code": { "type": "string", "description": "渠道编码，参见 SmsChannelEnum 枚举类", "example": "YUN_PIAN" }, "status": { "type": "integer", "description": "启用状态", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "好吃！" }, "apiKey": { "type": "string", "description": "短信 API 的账号；若与查询脱敏展示一致则保留原值", "example": "todo" }, "apiSecret": { "type": "string", "description": "短信 API 的密钥；传 ****** 保留原值", "example": "yuanma" }, "callbackUrl": { "type": "string", "description": "短信发送回调 URL", "example": "http://www.iocoder.cn" } }, "description": "管理后台 - 短信渠道创建/修改 Request VO" }, "SysShortLinkGroupSaveReqVO": { "required": [ "groupName" ], "type": "object", "properties": { "id": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 }, "groupName": { "type": "string", "description": "分组名称", "example": "默认分组" }, "groupCode": { "type": "string", "description": "分组编码，唯一标识该分组", "example": "DEFAULT" }, "sort": { "type": "integer", "description": "排序值，越小越靠前", "format": "int32", "example": 0 }, "description": { "type": "string", "description": "分组描述", "example": "默认分组描述" }, "remark": { "type": "string", "description": "备注信息", "example": "备注" } }, "description": "管理后台 - 短链分组新增/修改 Request VO" }, "SensitiveWordSaveVO": { "required": [ "name", "status", "tags" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "敏感词", "example": "敏感词" }, "tags": { "type": "array", "description": "标签", "example": "短信,评论", "items": { "type": "string", "description": "标签", "example": "短信,评论" } }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "description": { "type": "string", "description": "描述", "example": "污言秽语" } }, "description": "管理后台 - 敏感词创建/修改 Request VO" }, "RoleSaveReqVO": { "required": [ "code", "name", "sort" ], "type": "object", "properties": { "id": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1 }, "name": { "maxLength": 30, "minLength": 0, "type": "string", "description": "角色名称", "example": "管理员" }, "code": { "maxLength": 100, "minLength": 0, "type": "string", "description": "角色编码", "example": "ADMIN" }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "remark": { "type": "string", "description": "备注", "example": "我是一个角色" } }, "description": "管理后台 - 角色创建 Request VO" }, "RoleUpdateStatusReqVO": { "required": [ "id", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1024 }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 } }, "description": "管理后台 - 角色更新状态 Request VO" }, "ProtocolStatementSaveReqVO": { "required": [ "content", "id", "language", "positionType", "status", "title" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 29647 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "29647" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "positionType": { "type": "integer", "description": "职责类型 1：登录页 2：注册页 3：结算页 4：提包页面 5：物流航线 6：关于应用 7：商品详情", "format": "int32", "example": 2 }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "boolean", "description": "状态", "example": false } }, "description": "管理后台 - 平台协议声明新增/修改 Request VO" }, "PostSaveReqVO": { "required": [ "code", "name", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "岗位编号", "format": "int64", "example": 1024 }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "description": "岗位名称", "example": "小土豆" }, "code": { "maxLength": 64, "minLength": 0, "type": "string", "description": "岗位编码", "example": "todo" }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "快乐的备注" } }, "description": "管理后台 - 岗位创建/修改 Request VO" }, "OAuth2UserUpdateReqVO": { "required": [ "nickname" ], "type": "object", "properties": { "nickname": { "maxLength": 30, "minLength": 0, "type": "string", "description": "用户昵称", "example": "芋艿" }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - OAuth2 更新用户基本信息 Request VO" }, "OAuth2ClientSaveReqVO": { "required": [ "accessTokenValiditySeconds", "authorizedGrantTypes", "clientId", "logo", "name", "redirectUris", "refreshTokenValiditySeconds", "secret", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "clientId": { "type": "string", "description": "客户端编号", "example": "tudou" }, "secret": { "type": "string", "description": "客户端密钥；传 ****** 保留原密钥", "example": "fan" }, "name": { "type": "string", "description": "应用名", "example": "土豆" }, "logo": { "type": "string", "description": "应用图标", "example": "https://www.iocoder.cn/xx.png" }, "description": { "type": "string", "description": "应用描述", "example": "我是一个应用" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "accessTokenValiditySeconds": { "type": "integer", "description": "访问令牌的有效期", "format": "int32", "example": 8640 }, "refreshTokenValiditySeconds": { "type": "integer", "description": "刷新令牌的有效期", "format": "int32", "example": 8640000 }, "redirectUris": { "type": "array", "description": "可重定向的 URI 地址", "example": "https://www.iocoder.cn", "items": { "type": "string", "description": "可重定向的 URI 地址", "example": "https://www.iocoder.cn" } }, "authorizedGrantTypes": { "type": "array", "description": "授权类型，参见 OAuth2GrantTypeEnum 枚举", "example": "password", "items": { "type": "string", "description": "授权类型，参见 OAuth2GrantTypeEnum 枚举", "example": "password" } }, "scopes": { "type": "array", "description": "授权范围", "example": "user_info", "items": { "type": "string", "description": "授权范围", "example": "user_info" } }, "autoApproveScopes": { "type": "array", "description": "自动通过的授权范围", "example": "user_info", "items": { "type": "string", "description": "自动通过的授权范围", "example": "user_info" } }, "authorities": { "type": "array", "description": "权限", "example": "system:user:query", "items": { "type": "string", "description": "权限", "example": "system:user:query" } }, "resourceIds": { "type": "array", "description": "资源", "example": 1024, "items": { "type": "string", "description": "资源", "example": "1024" } }, "additionalInformation": { "type": "string", "description": "附加信息", "example": "{yunai: true}" }, "partnerName": { "type": "string", "description": "合作方名称（开放平台运营展示）", "example": "顺丰国际" }, "partnerContact": { "type": "string", "description": "合作方联系人（开放平台）", "example": "张三 / zhangsan@xx.com" }, "ipWhitelist": { "type": "string", "description": "IP 白名单，逗号分隔；为空不限制（开放平台）", "example": "1.1.1.1,2.2.2.2" }, "rateLimitQps": { "type": "integer", "description": "每秒限流 QPS；0 表示不限流（开放平台）", "format": "int32", "example": 50 }, "additionalInformationJson": { "type": "boolean" } }, "description": "管理后台 - OAuth2 客户端创建/修改 Request VO" }, "NotifyTemplateSaveReqVO": { "required": [ "code", "content", "languageCode", "name", "nickname", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "模版名称", "example": "测试模版" }, "code": { "type": "string", "description": "模版编码", "example": "SEND_TEST" }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "SEND_TEST" }, "type": { "type": "integer", "description": "模版类型，对应 system_notify_template_type 字典", "format": "int32", "example": 1 }, "nickname": { "type": "string", "description": "发送人名称", "example": "土豆" }, "content": { "type": "string", "description": "模版内容", "example": "我是模版内容" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "我是备注" } }, "description": "管理后台 - 站内信模版创建/修改 Request VO" }, "NoticeSaveReqVO": { "required": [ "content", "id", "status", "title", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "岗位公告编号", "format": "int64", "example": 1024 }, "title": { "maxLength": 50, "minLength": 0, "type": "string", "description": "公告标题", "example": "小博主" }, "type": { "type": "integer", "description": "公告类型", "format": "int32" }, "content": { "type": "string", "description": "公告内容", "example": "半生编码" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 通知公告创建/修改 Request VO" }, "MenuSaveVO": { "required": [ "name", "parentId", "sort", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "菜单编号", "format": "int64", "example": 1024 }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "description": "菜单名称", "example": "芋道" }, "permission": { "maxLength": 100, "minLength": 0, "type": "string", "description": "权限标识,仅菜单类型为按钮时，才需要传递", "example": "sys:menu:add" }, "type": { "type": "integer", "description": "类型，参见 MenuTypeEnum 枚举类", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "parentId": { "type": "integer", "description": "父菜单 ID", "format": "int64", "example": 1024 }, "path": { "maxLength": 200, "minLength": 0, "type": "string", "description": "路由地址,仅菜单类型为菜单或者目录时，才需要传", "example": "post" }, "icon": { "type": "string", "description": "菜单图标,仅菜单类型为菜单或者目录时，才需要传", "example": "/menu/list" }, "component": { "maxLength": 200, "minLength": 0, "type": "string", "description": "组件路径,仅菜单类型为菜单时，才需要传", "example": "system/post/index" }, "componentName": { "type": "string", "description": "组件名", "example": "SystemUser" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "visible": { "type": "boolean", "description": "是否可见", "example": false }, "keepAlive": { "type": "boolean", "description": "是否缓存", "example": false }, "alwaysShow": { "type": "boolean", "description": "是否总是显示", "example": false } }, "description": "管理后台 - 菜单创建/修改 Request VO" }, "MailTemplateSaveReqVO": { "required": [ "accountId", "code", "content", "languageCode", "name", "status", "title" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "模版名称", "example": "测试名字" }, "code": { "type": "string", "description": "模版编号", "example": "test" }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "test" }, "accountId": { "type": "integer", "description": "发送的邮箱账号编号", "format": "int64", "example": 1 }, "nickname": { "type": "string", "description": "发送人名称", "example": "芋头" }, "title": { "type": "string", "description": "标题", "example": "注册成功" }, "content": { "type": "string", "description": "内容", "example": "你好，注册成功啦" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "奥特曼" } }, "description": "管理后台 - 邮件模版创建/修改 Request VO" }, "MailAccountSaveReqVO": { "required": [ "host", "mail", "password", "port", "sslEnable", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "mail": { "type": "string", "description": "邮箱；若与查询脱敏展示一致则保留原值", "example": "todoyuanma@123.com" }, "username": { "type": "string", "description": "用户名；若与查询脱敏展示一致则保留原值", "example": "todo" }, "password": { "type": "string", "description": "密码；传 ****** 或与脱敏展示一致时保留原密码", "example": "123456" }, "host": { "type": "string", "description": "SMTP 服务器域名", "example": "www.iocoder.cn" }, "port": { "type": "integer", "description": "SMTP 服务器端口", "format": "int32", "example": 80 }, "sslEnable": { "type": "boolean", "description": "是否开启 ssl", "example": true } }, "description": "管理后台 - 邮箱账号创建/修改 Request VO" }, "SystemLanguageSaveReqVO": { "required": [ "langCode", "langName", "showFlag", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "langCode": { "maxLength": 10, "minLength": 0, "type": "string", "description": "语言代码", "example": "zh" }, "langName": { "maxLength": 64, "minLength": 0, "type": "string", "description": "语言名称", "example": "中文（简体）" }, "showFlag": { "type": "boolean", "description": "是否显示（true-是 false-否）", "example": true }, "whitelistUserIds": { "type": "array", "description": "白名单用户ID列表，[\"ALL\"] 表示全部用户", "example": [ "ALL" ], "items": { "type": "string", "description": "白名单用户ID列表，[\"ALL\"] 表示全部用户", "example": "[\"ALL\"]" } }, "whitelistCountries": { "type": "array", "description": "白名单国家列表，[\"ALL\"] 表示全部国家", "example": [ "ALL" ], "items": { "type": "string", "description": "白名单国家列表，[\"ALL\"] 表示全部国家", "example": "[\"ALL\"]" } }, "sort": { "type": "integer", "description": "排序值", "format": "int32", "example": 0 }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 0 }, "remark": { "maxLength": 500, "minLength": 0, "type": "string", "description": "备注", "example": "这是一个备注" } }, "description": "管理后台 - 系统语言配置创建/修改 Request VO" }, "InformationSaveReqVO": { "required": [ "businessType", "content", "id", "language", "recommend", "status", "summary", "terminalType", "title", "topicType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 5584 }, "uuidCode": { "type": "string", "description": "uuidCode", "nullable": true, "example": "5584" }, "title": { "type": "string", "description": "标题" }, "summary": { "type": "string", "description": "摘要" }, "content": { "type": "string", "description": "内容" }, "topicType": { "type": "integer", "description": "主题类型 ", "format": "int64", "example": 1 }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "businessType": { "type": "integer", "description": "业务类型 1：公告 2：资讯 ", "format": "int32", "example": 2 }, "terminalType": { "type": "integer", "description": "终端类型 1:PC 2:APP", "format": "int32", "example": 2 }, "sort": { "type": "integer", "description": "排序-升序", "format": "int32" }, "status": { "type": "boolean", "description": "状态（0正常 1关闭）", "example": false }, "recommend": { "type": "boolean", "description": "是否推荐阅读（0否 1是）", "example": false } }, "description": "管理后台 - 平台资讯内容新增/修改 Request VO" }, "GatewayIpBlacklistSaveReqVO": { "required": [ "ip" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号；新增时不传", "format": "int64" }, "ip": { "maxLength": 64, "minLength": 0, "type": "string", "description": "IP 或 CIDR，例如 1.2.3.4 / 1.2.3.0/24 / 2408::/32" }, "ipType": { "type": "string", "description": "IP 类型：EXACT / CIDR；为空时由后端按字面量推断" }, "reason": { "maxLength": 255, "minLength": 0, "type": "string", "description": "封禁原因" }, "expireTime": { "type": "string", "description": "到期时间；为空表示永久封禁", "format": "date-time" }, "source": { "type": "string", "description": "来源：MANUAL / ALERT / JOB；新增时不传默认 MANUAL" }, "status": { "type": "integer", "description": "状态：0-禁用，1-启用；新增时不传默认 1", "format": "int32" } }, "description": "管理后台 - 网关 IP 黑名单新增/修改 Request VO" }, "GatewayIpBlacklistRenewReqVO": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "黑名单编号", "format": "int64" }, "expireTime": { "type": "string", "description": "新的到期时间；为空时按 extendMinutes 累加；与 extendMinutes 二选一传一", "format": "date-time" }, "extendMinutes": { "type": "integer", "description": "在当前到期时间（或当前时间）上增加分钟数；与 expireTime 二选一传一", "format": "int32" }, "permanent": { "type": "boolean", "description": "是否切换为永久封禁；true 时清空 expireTime，忽略上面两个字段" } }, "description": "管理后台 - 网关 IP 黑名单续期 Request VO" }, "ErrorCodeSaveReqVO": { "required": [ "applicationName", "code", "langType", "message" ], "type": "object", "properties": { "id": { "type": "integer", "description": "错误码编号", "format": "int64", "example": 1024 }, "applicationName": { "type": "string", "description": "应用名", "example": "dashboard" }, "code": { "type": "integer", "description": "错误码编码", "format": "int32", "example": 1234 }, "langType": { "type": "string", "description": "多语言", "example": "zh" }, "message": { "type": "string", "description": "错误码错误提示", "example": "帅气" }, "memo": { "type": "string", "description": "备注", "example": "哈哈哈" } }, "description": "管理后台 - 错误码创建/修改 Request VO" }, "DictTypeSaveReqVO": { "required": [ "name", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "字典类型编号", "format": "int64", "example": 1024 }, "name": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典名称", "example": "性别" }, "type": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典类型", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "快乐的备注" } }, "description": "管理后台 - 字典类型创建/修改 Request VO" }, "DictDataSaveReqVO": { "required": [ "dictType", "label", "sort", "status", "value" ], "type": "object", "properties": { "id": { "type": "integer", "description": "字典数据编号", "format": "int64", "example": 1024 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典标签", "example": "芋道" }, "value": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典值", "example": "iocoder" }, "dictType": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典类型", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "colorType": { "type": "string", "description": "颜色类型,default、primary、success、info、warning、danger", "example": "default" }, "cssClass": { "type": "string", "description": "css 样式", "example": "btn-visible" }, "remark": { "type": "string", "description": "备注", "example": "我是一个角色" } }, "description": "管理后台 - 字典数据创建/修改 Request VO" }, "DeptSaveReqVO": { "required": [ "name", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1024 }, "name": { "maxLength": 30, "minLength": 0, "type": "string", "description": "部门名称", "example": "芋道" }, "parentId": { "type": "integer", "description": "父部门 ID", "format": "int64", "example": 1024 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "leaderUserId": { "type": "integer", "description": "负责人的用户编号", "format": "int64", "example": 2048 }, "phone": { "maxLength": 11, "minLength": 0, "type": "string", "description": "联系电话", "example": "15601691000" }, "email": { "maxLength": 50, "minLength": 0, "type": "string", "description": "邮箱", "example": "todo@iocoder.cn" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 } }, "description": "管理后台 - 部门创建/修改 Request VO" }, "CurrencyRatePolicySaveReqVO": { "required": [ "policyType", "premiumRate" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64" }, "policyType": { "type": "integer", "description": "策略类型：1-按国家 2-按客户", "format": "int32" }, "countryCode": { "type": "string", "description": "国家编码(策略类型=按国家时必填)" }, "userId": { "type": "integer", "description": "用户ID(策略类型=按客户时必填)", "format": "int64" }, "premiumRate": { "type": "number", "description": "溢价比例(%)，0表示返回实时汇率" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "remark": { "type": "string", "description": "备注说明" } }, "description": "管理后台 - 汇率策略配置新增/修改 Request VO" }, "CommonClassifySaveReqVO": { "required": [ "className", "id", "language", "parentId", "positionType", "sort", "status", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 17162 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "17162" }, "className": { "type": "string", "description": "分类名称", "example": "王五" }, "parentId": { "type": "integer", "description": "父Id(当前表）", "format": "int64", "example": 16881 }, "positionType": { "type": "integer", "description": "定位类型 1：帮助中心 ", "format": "int32", "example": 1 }, "isHot": { "type": "boolean", "description": "热门分类 0否 1是" }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 } }, "description": "管理后台 - 平台分类管理新增/修改 Request VO" }, "BasicRegionSaveReqVO": { "required": [ "countryId", "id", "name", "province", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 2942 }, "name": { "type": "string", "description": "名称", "example": "赵六" }, "province": { "type": "integer", "description": "类型", "format": "int32" }, "regionCode": { "type": "string", "description": "行政区代码" }, "countryId": { "type": "integer", "description": "所属国家", "format": "int64", "example": 528 }, "postalCode": { "type": "string", "description": "邮编" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示次序", "format": "int64" } }, "description": "管理后台 - 行政地区管理新增/修改 Request VO" }, "BasicCurrencySaveReqVO": { "required": [ "abbreviationCode", "exchangeRate", "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64" }, "name": { "type": "string", "description": "名称" }, "abbreviationCode": { "type": "string", "description": "国际缩写" }, "exchangeRate": { "type": "number", "description": "汇率" }, "icon": { "type": "string", "description": "图标" }, "symbol": { "type": "string", "description": "符号" }, "showStatus": { "type": "integer", "description": "C端展示状态0：不展示1：展示", "format": "int32" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "sort": { "type": "integer", "description": "排序 1-999 数字升序", "format": "int32" } }, "description": "管理后台 - 系统-基础数据-币种新增/修改 Request VO" }, "BasicCountrySaveReqVO": { "required": [ "areaId", "enName", "enShortName", "id", "localName", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 296 }, "enName": { "type": "string", "description": "名称(英文)", "example": "王五" }, "localName": { "type": "string", "description": "名称(本地)", "example": "赵六" }, "enShortName": { "type": "string", "description": "简称(英文)", "example": "李四" }, "currencyId": { "type": "integer", "description": "默认币种（对应币种id）", "format": "int64", "example": 31635 }, "areaId": { "type": "integer", "description": "默认区域 对应area表id", "format": "int32", "example": 18455 }, "icon": { "type": "string", "description": "图标" }, "isHot": { "type": "boolean", "description": "是否热门国家 0否 1是" }, "globalCode": { "type": "string", "description": "国际区号" }, "postalCode": { "type": "string", "description": "邮编" }, "letterGroup": { "type": "string", "description": "首字母分组 ABC/BCD" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" } }, "description": "管理后台 - 国家信息新增/修改 Request VO" }, "BasicAreaSaveReqVO": { "required": [ "enName", "id", "localName", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 25796 }, "enName": { "type": "string", "description": "名称(英文)", "example": "李四" }, "localName": { "type": "string", "description": "名称(本地)", "example": "李四" }, "description": { "type": "string", "description": "描述", "example": "你猜" }, "icon": { "type": "string", "description": "图标" }, "sort": { "type": "integer", "description": "显示次序", "format": "int64" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 } }, "description": "管理后台 - 区域管理新增/修改 Request VO" }, "BannerSaveReqVO": { "required": [ "id", "imgUrl", "language", "name", "redirectType", "sceneType", "sort", "status", "terminalType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64", "example": 9461 }, "name": { "type": "string", "description": "banner名称", "example": "王五" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "targetLink": { "type": "string", "description": "跳转链接" }, "redirectType": { "type": "integer", "description": "跳转类型", "format": "int32", "example": 1 }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型 21:PC 31:APP", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 2 }, "sceneType": { "type": "string", "description": "页面场景类型", "example": "HOME" }, "displayStrategy": { "type": "string", "description": "展示策略（ALL=全部用户 NEW=新用户 OLD=老客户）", "example": "ALL" }, "themeMode": { "type": "string", "description": "主题模式（ALL=不限 LIGHT=仅明亮模式 DARK=仅暗黑模式）", "example": "ALL" } }, "description": "管理后台 - banner新增/修改 Request VO" }, "AppVersionSaveReqVO": { "required": [ "downloadUrl", "os", "updateType", "versionCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "os": { "type": "string", "description": "操作系统: ANDROID / IOS", "example": "ANDROID" }, "versionCode": { "pattern": "^\\d+\\.\\d+\\.\\d+$", "type": "string", "description": "版本号", "example": "2.1.0" }, "updateType": { "type": "integer", "description": "更新类型: 1-强制更新 2-可选更新", "format": "int32", "example": 2 }, "downloadUrl": { "type": "string", "description": "下载地址", "example": "https://example.com/app.apk" }, "updateContent": { "type": "string", "description": "更新日志(JSON 多语言)", "example": "{\"zh\":\"修复已知问题\",\"en\":\"Fix known issues\"}" }, "minSupportVersion": { "type": "string", "description": "最低支持版本号", "example": "1.0.0" }, "remark": { "type": "string", "description": "备注", "example": "这是一个备注" } }, "description": "管理后台 - App版本创建/修改 Request VO" }, "AppVersionGraySaveReqVO": { "required": [ "grayType", "grayValue", "status", "versionId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "versionId": { "type": "integer", "description": "关联版本ID", "format": "int64", "example": 1 }, "grayType": { "type": "integer", "description": "灰度类型: 1-按用户ID 2-按比例 3-按地区", "format": "int32", "example": 1 }, "grayValue": { "type": "string", "description": "灰度值(JSON)", "example": "[\"1001\",\"1002\"]" }, "status": { "type": "integer", "description": "状态: 0-禁用 1-启用", "format": "int32", "example": 1 } }, "description": "管理后台 - App版本灰度规则创建/修改 Request VO" }, "AdvertSaveReqVO": { "required": [ "id", "imgUrl", "language", "sort", "status", "terminalType", "title" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 19495 }, "uuidCode": { "type": "string", "description": "uuidCode", "nullable": true, "example": "19495" }, "title": { "type": "string", "description": "标题" }, "sketchText": { "type": "string", "description": "简述文案" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "targetLink": { "type": "string", "description": "跳转链接" }, "buttonCnfig": { "type": "string", "description": "按钮配置json字段" }, "language": { "type": "string", "description": "语种" }, "terminalType": { "type": "integer", "description": "终端类型1:PC 2:APP", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "帐号状态（0正常 1停用）", "format": "int32", "example": 2 } }, "description": "管理后台 - 广告栏位新增/修改 Request VO" }, "SocialUserLoginAndBindReqDTO": { "required": [ "code", "state", "type" ], "type": "object", "properties": { "type": { "type": "integer", "description": "社交平台的类型，参见 SocialTypeEnum 枚举值", "format": "int32", "example": 10 }, "code": { "type": "string", "description": "授权码", "example": "1024" }, "state": { "type": "string", "description": "state", "example": "9b2ffbc1-7425-4155-9894-9d5c08541d62" }, "countryCode": { "type": "string", "description": "所属国家编码", "example": "CN" }, "invitationCode": { "type": "string", "description": "邀请码", "example": "9b2ff" }, "terminal": { "type": "integer", "description": "终端类型", "format": "int32", "example": 1 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "redirectUri": { "type": "string", "description": "重定向URI", "example": "https://example.com/callback" }, "eventData": { "type": "string", "description": "事件数据（埋点）" } }, "description": "用户 APP - 社交快捷登录 Request VO，使用 code 授权码" }, "CommonResultSocialUserRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SocialUserRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialUserRespDTO": { "required": [ "openid", "userId" ], "type": "object", "properties": { "openid": { "type": "string", "description": "社交用户 openid", "example": "zsw" }, "userId": { "type": "integer", "description": "关联的用户编号", "format": "int64", "example": 1024 } }, "description": "RPC 服务 - 社交用户 Response DTO" }, "SocialUserBindReqDTO": { "required": [ "code", "socialType", "state", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "socialType": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "授权码", "example": "zsw" }, "state": { "type": "string", "description": "state", "example": "qtw" } }, "description": "RPC 服务 - 取消绑定社交用户 Request DTO" }, "SmsSendSingleToUserReqDTO": { "required": [ "mobile", "templateCode" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "templateCode": { "type": "string", "description": "短信模板编号", "example": "USER_SEND" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "短信模板参数" }, "description": "短信模板参数" } }, "description": "RPC 服务 - 短信发送给 Admin 或者 Member 用户 Request DTO" }, "CommonResultLong": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "integer", "format": "int64" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppSensitiveWordValidReqDTO": { "type": "object", "properties": { "text": { "type": "string", "description": "文本内容", "example": "2" }, "textList": { "type": "array", "description": "文本列表", "example": 2, "items": { "type": "string", "description": "文本列表", "example": "2" } }, "tags": { "type": "array", "description": "敏感词指定标签", "example": 2, "items": { "type": "string", "description": "敏感词指定标签", "example": "2" } } }, "description": "RPC 服务 - 敏感词检测 Request DTO" }, "CommonResultListString": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "type": "string" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OperateLogCreateReqDTO": { "required": [ "duration", "javaMethod", "module", "name", "requestMethod", "requestUrl", "resultCode", "startTime", "type", "userAgent", "userId", "userIp", "userType" ], "type": "object", "properties": { "traceId": { "type": "string", "description": "链路追踪编号", "example": "89aca178-a370-411c-ae02-3f0d672be4ab" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "module": { "type": "string", "description": "操作模块", "example": "订单" }, "name": { "type": "string", "description": "操作名", "example": "创建订单" }, "type": { "type": "integer", "description": "操作分类，参见 SysOperateLogTypeEnum 枚举类", "format": "int32", "example": 1 }, "content": { "type": "string", "description": "操作明细", "example": "修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。" }, "exts": { "type": "object", "additionalProperties": { "type": "object", "description": "拓展字段", "example": "{'orderId': 1}" }, "description": "拓展字段", "example": "{'orderId': 1}" }, "requestMethod": { "type": "string", "description": "请求方法名", "example": "GET" }, "requestUrl": { "type": "string", "description": "请求地址", "example": "/xxx/yyy" }, "userIp": { "type": "string", "description": "用户 IP", "example": "127.0.0.1" }, "userAgent": { "type": "string", "description": "浏览器 UserAgent", "example": "Mozilla/5.0" }, "javaMethod": { "type": "string", "description": "Java 方法名", "example": "com.todo.buy.UserController.save(...)" }, "javaMethodArgs": { "type": "string", "description": "Java 方法的参数" }, "startTime": { "type": "string", "description": "开始时间", "format": "date-time" }, "duration": { "type": "integer", "description": "执行时长，单位：毫秒", "format": "int32" }, "resultCode": { "type": "integer", "description": "结果码", "format": "int32" }, "resultMsg": { "type": "string", "description": "结果提示" }, "resultData": { "type": "string", "description": "结果数据" } }, "description": "RPC 服务 - 操作日志创建 Request DTO" }, "OAuth2AccessTokenCreateReqDTO": { "required": [ "clientId", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 10 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 1 }, "clientId": { "type": "string", "description": "客户端编号", "example": "todoyuanma" }, "scopes": { "type": "array", "description": "授权范围的数组", "example": "user_info", "items": { "type": "string", "description": "授权范围的数组", "example": "user_info" } } }, "description": "RPC 服务 - OAuth2 访问令牌创建 Request DTO" }, "SmsCodeSendReqDTO": { "required": [ "createIp", "mobile", "scene" ], "type": "object", "properties": { "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "createIp": { "type": "string", "description": "发送 IP", "example": "10.20.30.40" } }, "description": "RPC 服务 - 短信验证码的发送 Request DTO" }, "MailCodeValidateReqDTO": { "required": [ "code", "mail", "scene" ], "type": "object", "properties": { "mail": { "type": "string", "description": "邮箱号", "example": "15601691300@163.com" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "验证码", "example": "1024" } }, "description": "RPC 服务 - 短信验证码的校验 Request DTO" }, "MailCodeSendReqDTO": { "required": [ "createIp", "email", "scene", "userId" ], "type": "object", "properties": { "email": { "type": "string", "description": "邮箱号", "example": "15601691300@163.com" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "createIp": { "type": "string", "description": "发送 IP", "example": "10.20.30.40" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 } }, "description": "RPC 服务 - 邮箱证码的发送 Request DTO" }, "NotifySendSingleToUserReqDTO": { "required": [ "templateCode", "userId" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "templateCode": { "type": "string", "description": "站内信模板编号", "example": "USER_SEND" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "邮件模板参数" }, "description": "邮件模板参数" } }, "description": "RPC 服务 - 站内信发送给 Admin 或者 Member 用户 Request DTO" }, "NotifyMessageReadReqDTO": { "required": [ "msgIds", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1024 }, "msgIds": { "type": "array", "description": "消息ID列表", "example": 1024, "items": { "type": "integer", "description": "消息ID列表", "format": "int64", "example": 1024 } } }, "description": "RPC 服务 - 站内信消息已读 Request DTO" }, "NotifyMessageListReqDTO": { "required": [ "pageNo", "pageSize", "type", "userId", "userType" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "type": { "type": "integer", "description": "站内信消息类型", "format": "int32" }, "keyword": { "type": "string", "description": "站内信搜索关键字", "nullable": true, "example": "12345" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1024 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } }, "readStatus": { "type": "boolean" } }, "description": "RPC 服务 - 站内信消息列表查询 Request DTO" }, "CommonResultNotifyMessageListRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NotifyMessageListRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyMessageListRespDTO": { "required": [ "list", "total", "unreadTotal" ], "type": "object", "properties": { "total": { "type": "integer", "description": "站内信消息总数", "format": "int64", "example": 14696 }, "list": { "type": "array", "description": "站内信消息列表", "items": { "$ref": "#/components/schemas/NotifyMessageRespDTO" } }, "unreadTotal": { "type": "integer", "description": "站内信未读总数", "format": "int64", "example": 14696 } }, "description": "RPC 服务 - 站内信消息列表查询 Response DTO" }, "NotifyMessageRespDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "userType": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int64" }, "templateCode": { "type": "string" }, "templateType": { "type": "integer", "format": "int32" }, "templateNickname": { "type": "string" }, "templateContent": { "type": "string" }, "templateName": { "type": "string" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object" } }, "readStatus": { "type": "boolean" }, "readTime": { "type": "string", "format": "date-time" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } }, "description": "RPC 服务 - 站内信消息列表查询 Response DTO" }, "NotifyMessageUnreadCountReqDTO": { "required": [ "pageNo", "pageSize", "userId", "userType" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1024 } }, "description": "RPC 服务 - 站内信消息列表查询 Request DTO" }, "CommonResultNotifyMessageUnreadCountRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NotifyMessageUnreadCountRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyMessageUnreadCountRespDTO": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "全部未读消息数量", "format": "int64" }, "announcementCount": { "type": "integer", "description": "重要公告-通知未读消息数量", "format": "int64" }, "systemCount": { "type": "integer", "description": "系统消息-通知未读消息数量", "format": "int64" }, "manualCount": { "type": "integer", "description": "人工消息-通知未读消息数量", "format": "int64" } }, "description": "RPC 服务 - 站内信消息未读数量查询 Response DTO" }, "NotifyMessageDetailReqDTO": { "required": [ "id", "userId", "userType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "消息ID", "format": "int64", "example": 1 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1024 } }, "description": "RPC 服务 - 站内信消息详情查询 Request DTO" }, "CommonResultNotifyMessageRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NotifyMessageRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyMessageDeleteReqDTO": { "required": [ "msgIds", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1024 }, "msgIds": { "type": "array", "description": "消息ID列表", "example": 1024, "items": { "type": "integer", "description": "消息ID列表", "format": "int64", "example": 1024 } } }, "description": "RPC 服务 - 站内信消息删除 Request DTO" }, "MailSendSingleToUserReqDTO": { "required": [ "mail", "templateCode" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "mail": { "type": "string", "description": "邮箱号", "example": "980489022@qq.com" }, "templateCode": { "type": "string", "description": "邮件模板编号", "example": "USER_SEND" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "邮件模板参数" }, "description": "邮件模板参数" } }, "description": "RPC 服务 - 邮件发送给 Admin 或者 Member 用户 Request DTO" }, "LoginLogCreateReqDTO": { "required": [ "logType", "result", "traceId", "userAgent", "userIp", "userType", "username" ], "type": "object", "properties": { "logType": { "type": "integer", "description": "日志类型，参见 LoginLogTypeEnum 枚举类", "format": "int32", "example": 1 }, "traceId": { "type": "string", "description": "链路追踪编号", "example": "89aca178-a370-411c-ae02-3f0d672be4ab" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 666 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 2 }, "username": { "maxLength": 30, "minLength": 0, "type": "string", "description": "用户账号", "example": "todo" }, "result": { "type": "integer", "description": "登录结果，参见 LoginResultEnum 枚举类", "format": "int32", "example": 1 }, "userIp": { "type": "string", "description": "用户 IP", "example": "127.0.0.1" }, "userAgent": { "type": "string", "description": "浏览器 UserAgent", "example": "Mozilla/5.0" }, "origin": { "type": "string", "description": "HTTP Origin 请求头", "example": "https://admin.example.com" }, "countryCode": { "type": "string", "description": "国家编码", "example": "CN" }, "localCountryName": { "type": "string", "description": "本地国家名称", "example": "中国" }, "ipParseResult": { "type": "string", "description": "IP解析结果详情（JSON格式）", "example": "{}" } }, "description": "RPC 服务 - 登录日志创建 Request DTO" }, "ErrorCodeAutoGenerateReqDTO": { "required": [ "applicationName", "code", "langType", "message" ], "type": "object", "properties": { "applicationName": { "type": "string", "description": "应用名", "example": "todo" }, "code": { "type": "integer", "description": "错误码编码", "format": "int32", "example": 1000 }, "message": { "type": "string", "description": "错误码错误提示", "example": "业务不能为空" }, "langType": { "type": "string", "description": "错误码多语言", "example": "业务不能为空" } }, "description": "RPC 服务 - 错误码自动生成 Request DTO" }, "CommonResultOAuth2OpenAccessTokenRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/OAuth2OpenAccessTokenRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OAuth2OpenAccessTokenRespVO": { "required": [ "access_token", "expires_in", "refresh_token", "token_type" ], "type": "object", "properties": { "scope": { "type": "string", "description": "授权范围,如果多个授权范围，使用空格分隔", "example": "user_info" }, "access_token": { "type": "string", "description": "访问令牌", "example": "tudou" }, "refresh_token": { "type": "string", "description": "刷新令牌", "example": "nice" }, "token_type": { "type": "string", "description": "令牌类型", "example": "bearer" }, "expires_in": { "type": "integer", "description": "过期时间,单位：秒", "format": "int64", "example": 42430 } }, "description": "管理后台 - 【开放接口】访问令牌 Response VO" }, "AppSigningKeyRespVO": { "required": [ "expiresAt", "keyId", "signingKey" ], "type": "object", "properties": { "keyId": { "type": "string", "description": "签名密钥 ID，请求时放入 X-Key-Id Header", "example": "sk-a1b2c3d4e5f6" }, "signingKey": { "type": "string", "description": "签名密钥，用于 HMAC-SHA256 计算 X-Sign", "example": "random-secret-string" }, "expiresAt": { "type": "integer", "description": "过期时间（毫秒时间戳）", "format": "int64", "example": 1743677700000 }, "serverTimeMillis": { "type": "integer", "description": "服务端当前毫秒时间戳，可与本地时间求差校准 X-Timestamp（可选，缓解设备时钟漂移）", "format": "int64", "example": 1743676800000 } }, "description": "用户 App - 请求签名密钥 Response VO" }, "CommonResultAppSigningKeyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppSigningKeyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppShortLinkQueryReqVO": { "required": [ "keyword" ], "type": "object", "properties": { "keyword": { "type": "string", "description": "短链地址或短链key", "example": "abc123def" } }, "description": "用户APP - 短链查询 Request VO" }, "AppShortLinkQueryRespVO": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "短链地址" }, "originalUrl": { "type": "string", "description": "长链地址（原始链接）" }, "shortLinkKey": { "type": "string", "description": "短链key" } }, "description": "用户APP - 短链查询 Response VO" }, "CommonResultAppShortLinkQueryRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppShortLinkQueryRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppShortLinkBuildReqVO": { "required": [ "type", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "原始链接，非空" }, "type": { "type": "integer", "description": "链接类型:1-商品详情页", "format": "int32" } }, "description": "用户APP - 短链生成 Request VO" }, "AppShortLinkBuildRespVO": { "type": "object", "properties": { "shortUrl": { "type": "string", "description": "短链地址" }, "longUrl": { "type": "string", "description": "长链地址" } }, "description": "用户APP - 短链生成 Response VO" }, "CommonResultAppShortLinkBuildRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppShortLinkBuildRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppMsgPushTokenRegisterReqVO": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string", "description": "消息令牌", "example": "19495" } }, "description": "用户 APP - 消息推送令牌注册 Request VO" }, "CommonResultUserImportRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/UserImportRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "UserImportRespVO": { "required": [ "createUsernames", "failureUsernames", "updateUsernames" ], "type": "object", "properties": { "createUsernames": { "type": "array", "description": "创建成功的用户名数组", "items": { "type": "string", "description": "创建成功的用户名数组" } }, "updateUsernames": { "type": "array", "description": "更新成功的用户名数组", "items": { "type": "string", "description": "更新成功的用户名数组" } }, "failureUsernames": { "type": "object", "additionalProperties": { "type": "string", "description": "导入失败的用户集合，key 为用户名，value 为失败原因" }, "description": "导入失败的用户集合，key 为用户名，value 为失败原因" } }, "description": "管理后台 - 用户导入 Response VO" }, "TranslationReqVO": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "targetLanuage": { "type": "string" } } }, "SysShortLinkRecordSaveReqVO": { "required": [ "originalUrl" ], "type": "object", "properties": { "originalUrl": { "type": "string", "description": "原始链接，非空", "example": "https://www.iocoder.cn" }, "remark": { "type": "string", "description": "备注", "example": "你猜" }, "groupId": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 } }, "description": "管理后台 - 短链接记录新增/修改 Request VO" }, "SocialUserBindReqVO": { "required": [ "code", "state", "type" ], "type": "object", "properties": { "type": { "type": "integer", "description": "社交平台的类型，参见 UserSocialTypeEnum 枚举值", "format": "int32", "example": 10 }, "code": { "type": "string", "description": "授权码", "example": "1024" }, "state": { "type": "string", "description": "state", "example": "9b2ffbc1-7425-4155-9894-9d5c08541d62" } }, "description": "管理后台 - 社交绑定 Request VO，使用 code 授权码" }, "SmsTemplateSendReqVO": { "required": [ "mobile", "templateCode" ], "type": "object", "properties": { "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "templateCode": { "type": "string", "description": "模板编码", "example": "test_01" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "模板参数" }, "description": "模板参数" } }, "description": "管理后台 - 短信模板的发送 Request VO" }, "AdminEncryptBootstrapReqVO": { "required": [ "encryptedAesKey", "rsaKeyId" ], "type": "object", "properties": { "rsaKeyId": { "type": "string", "description": "RSA 密钥版本标识", "example": "rsa-v1" }, "encryptedAesKey": { "type": "string", "description": "RSA 公钥加密后的 AES 密钥（Base64）" } }, "description": "管理后台 - 加密密钥协商 Request VO" }, "AdminEncryptBootstrapRespVO": { "type": "object", "properties": { "encKeyId": { "type": "string", "description": "AES 会话密钥标识", "example": "ek-a1b2c3d4e5f6" }, "expiresAt": { "type": "integer", "description": "过期时间戳（毫秒）", "format": "int64", "example": 1743678600000 } }, "description": "管理后台 - 加密密钥协商 Response VO" }, "CommonResultAdminEncryptBootstrapRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AdminEncryptBootstrapRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PermissionAssignUserRoleReqVO": { "required": [ "userId" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1 }, "roleIds": { "uniqueItems": true, "type": "array", "description": "角色编号列表", "example": "1,3,5", "items": { "type": "integer", "description": "角色编号列表", "format": "int64" } } }, "description": "管理后台 - 赋予用户角色 Request VO" }, "PermissionAssignRoleMenuReqVO": { "required": [ "roleId" ], "type": "object", "properties": { "roleId": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1 }, "menuIds": { "uniqueItems": true, "type": "array", "description": "菜单编号列表", "example": "1,3,5", "items": { "type": "integer", "description": "菜单编号列表", "format": "int64" } } }, "description": "管理后台 - 赋予角色菜单 Request VO" }, "PermissionAssignRoleDataScopeReqVO": { "required": [ "dataScope", "roleId" ], "type": "object", "properties": { "roleId": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1 }, "dataScope": { "type": "integer", "description": "数据范围，参见 DataScopeEnum 枚举类", "format": "int32", "example": 1 }, "dataScopeDeptIds": { "uniqueItems": true, "type": "array", "description": "部门编号列表，只有范围类型为 DEPT_CUSTOM 时，该字段才需要", "example": "1,3,5", "items": { "type": "integer", "description": "部门编号列表，只有范围类型为 DEPT_CUSTOM 时，该字段才需要", "format": "int64" } } }, "description": "管理后台 - 赋予角色数据权限 Request VO" }, "NotifyTemplateSendReqVO": { "required": [ "templateCode", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户id", "format": "int64", "example": 1 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "templateCode": { "type": "string", "description": "模板编码", "example": "01" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "模板参数" }, "description": "模板参数" } }, "description": "管理后台 - 站内信模板的发送 Request VO" }, "MailTemplateSendReqVO": { "required": [ "mail", "templateCode" ], "type": "object", "properties": { "mail": { "type": "string", "description": "接收邮箱", "example": "7685413@qq.com" }, "templateCode": { "type": "string", "description": "模板编码", "example": "test_01" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "模板参数" }, "description": "模板参数" } }, "description": "管理后台 - 邮件发送 Req VO" }, "MailLogResendReqVO": { "required": [ "logId", "mode" ], "type": "object", "properties": { "logId": { "type": "integer", "description": "源邮件日志编号", "format": "int64", "example": 1024 }, "mode": { "type": "string", "description": "重发模式：SNAPSHOT=快照，REFRESH=按当前模板重算", "example": "SNAPSHOT", "enum": [ "SNAPSHOT", "REFRESH" ] } }, "description": "管理后台 - 邮件日志重发 Request VO" }, "CommonResultInteger": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "GatewayIpBlacklistBatchReqVO": { "required": [ "ips" ], "type": "object", "properties": { "ips": { "type": "array", "description": "IP / CIDR 列表（每行一条）", "items": { "type": "string", "description": "IP / CIDR 列表（每行一条）" } }, "reason": { "type": "string", "description": "封禁原因（统一应用到所有条目）" }, "expireTime": { "type": "string", "description": "到期时间（统一应用到所有条目）；为空表示永久封禁", "format": "date-time" }, "source": { "type": "string", "description": "来源：MANUAL / ALERT / JOB；不传默认 MANUAL" } }, "description": "管理后台 - 网关 IP 黑名单批量新增 Request VO" }, "CommonResultMapStringObject": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AuthLoginReqVO": { "required": [ "password", "socialCode", "socialState", "socialType", "username" ], "type": "object", "properties": { "username": { "pattern": "^[A-Za-z0-9]+$", "type": "string", "description": "账号", "example": "todoyuanma" }, "password": { "type": "string", "description": "密码", "example": "buzhidao" }, "turnstileToken": { "type": "string", "description": "Cloudflare Turnstile 校验 token；管理端开启 Turnstile 时必填", "example": "0.xxx" }, "socialType": { "type": "integer", "description": "社交平台的类型，参见 SocialTypeEnum 枚举值", "format": "int32", "example": 10 }, "socialCode": { "type": "string", "description": "授权码", "example": "1024" }, "socialState": { "type": "string", "description": "state", "example": "9b2ffbc1-7425-4155-9894-9d5c08541d62" }, "socialCodeValid": { "type": "boolean" } }, "description": "管理后台 - 账号密码登录 Request VO，如果登录并绑定社交用户，需要传递 social 开头的参数" }, "AuthLoginRespVO": { "required": [ "accessToken", "expiresTime", "refreshToken", "userId" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "accessToken": { "type": "string", "description": "访问令牌", "example": "happy" }, "refreshToken": { "type": "string", "description": "刷新令牌", "example": "nice" }, "expiresTime": { "type": "string", "description": "过期时间", "format": "date-time" } }, "description": "管理后台 - 登录 Response VO" }, "CommonResultAuthLoginRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AuthLoginRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AdminUserRespDTO": { "required": [ "deptId", "id", "mobile", "nickname", "postIds", "status", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户 ID", "format": "int64", "example": 1024 }, "username": { "type": "string", "description": "用户账号", "example": "admin" }, "nickname": { "type": "string", "description": "用户昵称", "example": "小王" }, "name": { "type": "string", "description": "真实姓名", "example": "张三" }, "status": { "type": "integer", "description": "帐号状态", "format": "int32", "example": 1 }, "deptId": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1 }, "postIds": { "uniqueItems": true, "type": "array", "description": "岗位编号数组", "example": [ 1, 3 ], "items": { "type": "integer", "description": "岗位编号数组", "format": "int64" } }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "email": { "type": "string", "description": "用户邮箱", "example": "admin@example.com" }, "avatar": { "type": "string", "description": "用户头像", "example": "小王" } }, "description": "RPC 服务 - Admin 用户 Response DTO" }, "CommonResultListAdminUserRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdminUserRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAdminUserRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AdminUserRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListLong": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultSocialWxJsapiSignatureRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SocialWxJsapiSignatureRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialWxJsapiSignatureRespDTO": { "required": [ "appId", "nonceStr", "signature", "timestamp", "url" ], "type": "object", "properties": { "appId": { "type": "string", "description": "微信公众号的 appId", "example": "wx123456" }, "nonceStr": { "type": "string", "description": "匿名串", "example": "zsw" }, "timestamp": { "type": "integer", "description": "时间戳", "format": "int64", "example": 123456789 }, "url": { "type": "string", "description": "URL", "example": "https://www.iocoder.cn" }, "signature": { "type": "string", "description": "签名", "example": "zsw" } }, "description": "RPC 服务 - 微信公众号 JSAPI 签名 Response DTO" }, "CommonResultSocialWxPhoneNumberInfoRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SocialWxPhoneNumberInfoRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialWxPhoneNumberInfoRespDTO": { "required": [ "countryCode", "phoneNumber", "purePhoneNumber" ], "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "用户绑定的手机号（国外手机号会有区号）", "example": "021-13579246810" }, "purePhoneNumber": { "type": "string", "description": "没有区号的手机号", "example": "13579246810" }, "countryCode": { "type": "string", "description": "区号", "example": "021" } }, "description": "RPC 服务 - 微信小程序的手机信息 Response DTO" }, "CommonResultPageResultShortLinkRecordRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultShortLinkRecordRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultShortLinkRecordRespDTO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/ShortLinkRecordRespDTO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "ShortLinkRecordRespDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "originalUrl": { "type": "string" }, "shortLinkKey": { "type": "string" }, "effective": { "type": "boolean" }, "saveClickRecord": { "type": "boolean" }, "remark": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" } }, "description": "数据" }, "AppProtocolStatementRespDTO": { "required": [ "content", "createTime", "id", "language", "positionType", "sort", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 29647 }, "uuidCode": { "type": "string", "description": "uuidcode唯一业务id", "example": "29647" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "positionType": { "type": "integer", "description": "职责类型 1：登录页 2：注册页 3：结算页 4：提包页面 5：物流航线 6:关于应用 7:商详", "format": "int32", "example": 2 }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "RPC 服务 - 平台协议声明 Response VO" }, "CommonResultListAppProtocolStatementRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppProtocolStatementRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultSetLong": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultDeptDataPermissionRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DeptDataPermissionRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DeptDataPermissionRespDTO": { "required": [ "all", "deptIds", "self" ], "type": "object", "properties": { "all": { "type": "boolean", "description": "是否可查看全部数据", "example": true }, "self": { "type": "boolean", "description": "是否可查看自己的数据", "example": true }, "deptIds": { "uniqueItems": true, "type": "array", "description": "可查看的部门编号数组", "example": [ 1, 3 ], "items": { "type": "integer", "description": "可查看的部门编号数组", "format": "int64" } } }, "description": "RPC 服务 - 部门的数据权限 Response DTO" }, "CommonResultOAuth2AccessTokenCheckRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/OAuth2AccessTokenCheckRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OAuth2AccessTokenCheckRespDTO": { "required": [ "tenantId", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 10 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 1 }, "tenantId": { "type": "integer", "description": "租户编号", "format": "int64", "example": 1024 }, "scopes": { "type": "array", "description": "授权范围的数组", "example": "user_info", "items": { "type": "string", "description": "授权范围的数组", "example": "user_info" } } }, "description": "RPC 服务 - OAuth2 访问令牌的校验 Response DTO" }, "SmsCodeValidateReqDTO": { "required": [ "code", "mobile", "scene" ], "type": "object", "properties": { "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "scene": { "type": "integer", "description": "发送场景", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "验证码", "example": "1024" } }, "description": "RPC 服务 - 短信验证码的校验 Request DTO" }, "CommonResultListErrorCodeRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorCodeRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "ErrorCodeRespDTO": { "required": [ "code", "message", "updateTime" ], "type": "object", "properties": { "langType": { "type": "string" }, "code": { "type": "integer", "description": "错误码编码", "format": "int32", "example": 1000 }, "message": { "type": "string", "description": "错误码错误提示", "example": "业务不能为空" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "RPC 服务 - 错误码 Response DTO" }, "CommonResultDictDataRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DictDataRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictDataRespDTO": { "required": [ "dictType", "label", "status", "value" ], "type": "object", "properties": { "label": { "type": "string", "description": "字典标签", "example": "芋道" }, "value": { "type": "string", "description": "字典值", "example": "iocoder" }, "dictType": { "type": "string", "description": "字典类型", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 } }, "description": "RPC 服务 - 字典数据 Response DTO" }, "CommonResultListDeptRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeptRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DeptRespDTO": { "required": [ "id", "leaderUserId", "name", "parentId", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "部门名称", "example": "研发部" }, "parentId": { "type": "integer", "description": "父部门编号", "format": "int64", "example": 1 }, "leaderUserId": { "type": "integer", "description": "负责人的用户编号", "format": "int64", "example": 1 }, "status": { "type": "integer", "description": "部门状态", "format": "int32", "example": 1 } }, "description": "RPC 服务 - 部门 Response DTO" }, "CommonResultDeptRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DeptRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppCurrencyRespDTO": { "required": [ "abbreviationCode", "exchangeRate", "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64" }, "name": { "type": "string", "description": "名称" }, "abbreviationCode": { "type": "string", "description": "国际缩写" }, "exchangeRate": { "type": "number", "description": "汇率" }, "realTimeExchangeRate": { "type": "number", "description": "实时汇率" }, "icon": { "type": "string", "description": "图标" }, "symbol": { "type": "string", "description": "符号" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "用户APP - 币种 ResponseDTO" }, "CommonResultListAppCurrencyRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCurrencyRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppCurrencyRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppCurrencyRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultMatchedPremiumRateRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/MatchedPremiumRateRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MatchedPremiumRateRespDTO": { "type": "object", "properties": { "policyId": { "type": "integer", "description": "策略ID", "format": "int64" }, "premiumRate": { "type": "number", "description": "溢价比例(%)" } }, "description": "匹配的汇率策略溢价信息 ResponseDTO" }, "CommonResultListCountryInfoRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CountryInfoRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CountryInfoRespDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "enName": { "type": "string" }, "localName": { "type": "string" }, "enShortName": { "type": "string" } } }, "CommonResultCountryInfoRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/CountryInfoRespDTO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BasicRegionIdRespDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "CommonResultListBasicRegionIdRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRegionIdRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BannerRespDTO": { "required": [ "createTime", "imgUrl", "language", "name", "redirectType", "sceneType", "sort", "status", "terminalType" ], "type": "object", "properties": { "name": { "type": "string", "description": "banner名称", "example": "活动" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.example.com/banner.png" }, "redirectType": { "type": "integer", "description": "跳转类型", "format": "int32", "example": 1 }, "targetLink": { "type": "string", "description": "跳转链接" }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型", "format": "int32", "example": 31 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 0 }, "sceneType": { "type": "string", "description": "页面场景类型（业务场景）", "example": "HOME" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "RPC - Banner Response DTO" }, "CommonResultListBannerRespDTO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BannerRespDTO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppSupportInfoRespVO": { "required": [ "classifyId", "classifyUuid", "content", "createTime", "id", "language", "terminalType", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 24031 }, "uuidCode": { "type": "string", "description": "uuidcode", "example": "24031" }, "title": { "type": "string", "description": "标题" }, "classifyId": { "type": "integer", "description": "分类id", "format": "int64", "example": 22436 }, "classifyUuid": { "type": "string", "description": "分类Uuid", "example": "22436" }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "terminalType": { "type": "integer", "description": "终端类型21:PC 31:APP", "format": "int32", "example": 2 }, "content": { "type": "string", "description": "内容" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "用户 APP - 帮助中心信息 Response VO" }, "CommonResultListAppSupportInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppSupportInfoRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppSupportInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppSupportInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppSupportInfoReqVO": { "type": "object", "properties": { "title": { "type": "string", "description": "标题" }, "classifyId": { "type": "integer", "description": "分类id", "format": "int64", "example": 1 }, "classifyUuId": { "type": "string", "description": "分类uuid", "example": "DFDGSFDF1" } }, "description": "用户 APP - 帮助中心信息 Request VO" }, "AppProtocolStatementRespVO": { "required": [ "content", "createTime", "id", "language", "positionType", "sort", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 29647 }, "uuidCode": { "type": "string", "description": "uuidcode唯一业务id", "example": "29647" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "positionType": { "type": "integer", "description": "职责类型 1：登录页 2：注册页 3：结算页 4：提包页面 5：物流航线", "format": "int32", "example": 2 }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "用户App - 平台协议声明 Response VO" }, "CommonResultListAppProtocolStatementRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppProtocolStatementRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppProtocolStatementRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppProtocolStatementRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppCustomerChannelRespVO": { "required": [ "openMode", "openUrl" ], "type": "object", "properties": { "openUrl": { "type": "string", "description": "客服应用打开URL", "example": "https://qiyukf.com/client?k=eaa16e0337164296350a0e9f3b77a7d9&wp=1" }, "openMode": { "type": "string", "description": "客服应用打开方式", "example": "url" } }, "description": "用户 APP - 在线客服配置 Response VO" }, "AppCustomerConfigRespVO": { "required": [ "channelCode", "channelConfig" ], "type": "object", "properties": { "channelCode": { "type": "string", "description": "客服渠道值" }, "channelConfig": { "$ref": "#/components/schemas/AppCustomerChannelRespVO" } }, "description": "用户 APP - 在线客服配置 Response VO" }, "CommonResultAppCustomerConfigRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppCustomerConfigRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppInformationTopicRespVO": { "required": [ "topicCode", "topicName", "topicType" ], "type": "object", "properties": { "topicType": { "type": "integer", "description": "主题类型", "format": "int64" }, "topicCode": { "type": "string", "description": "主题code" }, "topicName": { "type": "string", "description": "主题名字" } }, "description": "用户 APP - 平台资讯内容主题类型 Response VO" }, "CommonResultListAppInformationTopicRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppInformationTopicRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppInformationRespVO": { "required": [ "businessType", "content", "createTime", "id", "language", "status", "summary", "terminalType", "title", "topicType", "updateTime", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 5584 }, "uuidCode": { "type": "string", "description": "唯一业务标识code", "example": "5584" }, "title": { "type": "string", "description": "标题" }, "summary": { "type": "string", "description": "摘要" }, "content": { "type": "string", "description": "内容" }, "topicType": { "type": "integer", "description": "主题类型 ", "format": "int32", "example": 1 }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "businessType": { "type": "integer", "description": "业务类型 1：公告 2：资讯 ", "format": "int32", "example": 2 }, "terminalType": { "type": "integer", "description": "终端类型 1:PC 2:APP", "format": "int32", "example": 2 }, "sort": { "type": "integer", "description": "排序-升序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1关闭）", "format": "int32", "example": 2 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "用户 APP - 平台资讯内容 Response VO" }, "CommonResultListAppInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppInformationRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppHomeInformationListRespVO": { "required": [ "topicName", "topicType" ], "type": "object", "properties": { "topicName": { "type": "string", "description": "主题名字", "example": "物流" }, "topicType": { "type": "string", "description": "主题类型", "example": "1" }, "informationRespVOS": { "type": "array", "description": "资讯数据list", "items": { "$ref": "#/components/schemas/AppInformationRespVO" } } }, "description": "用户 APP - 首页资讯信息List Response VO" }, "CommonResultListAppHomeInformationListRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppHomeInformationListRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppInformationRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppInformationPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "topicType": { "type": "integer", "description": "主题类型 null:全部 1:物流信息 2:营销活动 ", "format": "int32", "example": 1 }, "topicTypeCode": { "type": "string", "description": "主题类型uuidcode", "example": "1" }, "businessType": { "type": "integer", "description": "业务类型 1：公告 2：资讯 (预留字段可先不传)", "format": "int32", "example": 2 } }, "description": "用户 APP - 平台资讯内容分页 Request VO" }, "CommonResultPageResultAppInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultAppInformationRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultAppInformationRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/AppInformationRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "AppBaseDynamicConfigRespVO": { "type": "object", "properties": { "newcomerInforMKey": { "type": "string", "description": "首页新人指引业务唯一uuidcode", "nullable": true, "example": "17162" }, "tariffThresholdMKey": { "type": "string", "description": "帮助中心关税起征点业务uuidcode", "nullable": true, "example": "17162" }, "paymentReceivedMKey": { "type": "string", "description": "帮助中心款项到账业务uuidcode", "nullable": true, "example": "17162" } }, "description": "用户 APP - 基础动态配置 Response VO" }, "CommonResultAppBaseDynamicConfigRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppBaseDynamicConfigRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppCommonClassifyRespVO": { "required": [ "children", "className", "createTime", "id", "language", "parentId", "parentUuid", "positionType", "sort", "status", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 17162 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "17162" }, "className": { "type": "string", "description": "分类名称", "example": "王五" }, "parentId": { "type": "integer", "description": "父Id(当前表）", "format": "int64", "example": 16881 }, "parentUuid": { "type": "string", "description": "父Uuid(当前表）", "example": "16881" }, "positionType": { "type": "integer", "description": "定位类型 1：帮助中心 ", "format": "int32", "example": 1 }, "isHot": { "type": "boolean", "description": "热门分类 0否 1是" }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "children": { "type": "array", "description": "子分类", "items": { "$ref": "#/components/schemas/AppCommonClassifyRespVO" } } }, "description": "用户 APP - 平台分类管理 Response VO" }, "CommonResultListAppCommonClassifyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCommonClassifyRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppCommonClassifyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppCommonClassifyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppRegionRespVO": { "required": [ "id", "name", "province" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 2942 }, "name": { "type": "string", "description": "名称", "example": "赵六" }, "province": { "type": "integer", "description": "类型", "format": "int32" }, "regionCode": { "type": "string", "description": "行政区代码" } }, "description": "用户 APP - 行政地区 Response VO" }, "CommonResultListAppRegionRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppRegionRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppBasicCountryRespVO": { "required": [ "areaId", "enName", "enShortName", "icon", "id", "isHot", "letterGroup", "localName", "sort" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 296 }, "enName": { "type": "string", "description": "名称(英文)", "example": "China" }, "localName": { "type": "string", "description": "名称(本地)", "example": "中国" }, "enShortName": { "type": "string", "description": "简称(英文)", "example": "CN" }, "areaId": { "type": "integer", "description": "默认区域 对应area表id", "format": "int32", "example": 18455 }, "icon": { "type": "string", "description": "图标" }, "isHot": { "type": "boolean", "description": "是否热门国家 0否 1是" }, "globalCode": { "type": "string", "description": "国际区号" }, "postalCode": { "type": "string", "description": "邮编" }, "letterGroup": { "type": "string", "description": "首字母分组 ABC/BCD" }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" }, "regionGroupRespVOS": { "type": "array", "description": "国家下的行政地区（省级）", "items": { "$ref": "#/components/schemas/AppRegionGroupRespVO" } } }, "description": "用户 APP - 国家信息 Response VO" }, "AppCountryGroupRespVO": { "required": [ "letterGroup" ], "type": "object", "properties": { "letterGroup": { "type": "string", "description": "首字母分组 ABC/BCD" }, "countryRespVOS": { "type": "array", "items": { "$ref": "#/components/schemas/AppBasicCountryRespVO" } } }, "description": "用户 APP - 首字母分组国家 Response VO" }, "AppRegionGroupRespVO": { "required": [ "id", "name", "province" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 2942 }, "name": { "type": "string", "description": "名称", "example": "赵六" }, "province": { "type": "integer", "description": "类型", "format": "int32" }, "regionCode": { "type": "string", "description": "行政区代码" } }, "description": "用户 APP - 行政地区 Response VO" }, "CommonResultListAppCountryGroupRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppCountryGroupRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultAppBasicCountryRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppBasicCountryRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListAppBasicCountryRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppBasicCountryRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppBannerRespVO": { "required": [ "createTime", "imgUrl", "language", "name", "redirectType", "sceneType", "sort", "status", "terminalType" ], "type": "object", "properties": { "name": { "type": "string", "description": "banner名称", "example": "王五" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "redirectType": { "type": "integer", "description": "跳转类型", "format": "int32", "example": 1 }, "targetLink": { "type": "string", "description": "跳转链接" }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型 21:PC 31:APP", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 2 }, "sceneType": { "type": "string", "description": "页面场景类型", "example": "HOME" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "用户 APP - banner Response VO" }, "CommonResultListAppBannerRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppBannerRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppSceneBannerRespVO": { "required": [ "bannerList", "sceneType" ], "type": "object", "properties": { "sceneType": { "type": "string", "description": "页面场景类型", "example": "HOME" }, "bannerList": { "type": "array", "description": "该场景下的banner列表", "items": { "$ref": "#/components/schemas/AppBannerRespVO" } } }, "description": "用户 APP - 场景Banner分组 Response VO" }, "CommonResultListAppSceneBannerRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppSceneBannerRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppAreaNodeRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int32", "example": 110000 }, "name": { "type": "string", "description": "名字", "example": "北京" } }, "description": "用户 App - 地区节点 Response VO" }, "CommonResultListAppAreaNodeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppAreaNodeRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppVersionCheckRespVO": { "required": [ "hasUpdate", "isForce" ], "type": "object", "properties": { "hasUpdate": { "type": "boolean", "description": "是否有新版本" }, "isForce": { "type": "boolean", "description": "是否强制更新" }, "latestVersion": { "type": "string", "description": "最新版本号" }, "currentVersion": { "type": "string", "description": "当前版本号" }, "downloadUrl": { "type": "string", "description": "下载地址" }, "updateContent": { "type": "string", "description": "更新内容" }, "publishTime": { "type": "string", "description": "发布时间", "format": "date-time" } }, "description": "用户 APP - 版本检查更新 Response VO" }, "CommonResultAppVersionCheckRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppVersionCheckRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultWebsiteMaintenanceConfigRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/WebsiteMaintenanceConfigRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "WebsiteMaintenanceConfigRespVO": { "type": "object", "properties": { "maintenance": { "type": "boolean", "description": "是否开启网站更新维护状态" }, "start": { "type": "integer", "description": "维护计划开始时间，Unix 毫秒时间戳，未配置为 null", "format": "int64" }, "end": { "type": "integer", "description": "维护计划结束时间，Unix 毫秒时间戳，未配置为 null", "format": "int64" } }, "description": "用户 APP - 网站更新停机维护配置 Response VO" }, "AppSearchGoodsSourceRespVO": { "type": "object", "properties": { "source": { "type": "integer", "description": "渠道ID", "format": "int32" }, "name": { "type": "string", "description": "渠道名称" }, "enabled": { "type": "boolean", "description": "是否启用" }, "defaultSearch": { "type": "boolean", "description": "是否默认搜索" } }, "description": "用户 APP - 商品渠道搜索配置信息 Response VO" }, "CommonResultListAppSearchGoodsSourceRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppSearchGoodsSourceRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppSystemLanguageRespVO": { "type": "object", "properties": { "langCode": { "type": "string", "description": "语言代码", "example": "zh" }, "langName": { "type": "string", "description": "语言名称", "example": "中文（简体）" }, "show": { "type": "boolean", "description": "是否显示", "example": true }, "whitelistUserIds": { "type": "array", "description": "白名单用户ID列表，如果为空或未配置，表示该语言对所有用户开放", "example": [ "123", "456" ], "items": { "type": "string", "description": "白名单用户ID列表，如果为空或未配置，表示该语言对所有用户开放", "example": "[\"123\",\"456\"]" } }, "whitelistCountries": { "type": "array", "description": "白名单国家列表，如果为空或未配置，表示该语言对所有国家开放", "example": [ "CN", "US", "JP" ], "items": { "type": "string", "description": "白名单国家列表，如果为空或未配置，表示该语言对所有国家开放", "example": "[\"CN\",\"US\",\"JP\"]" } } }, "description": "用户 APP - 系统多语言配置信息 Response VO" }, "CommonResultListAppSystemLanguageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppSystemLanguageRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppBasicConfigInfoRespVO": { "type": "object", "properties": { "appSearchGoodsSourceList": { "type": "array", "description": "商品渠道搜索配置列表", "items": { "$ref": "#/components/schemas/AppSearchGoodsSourceRespVO" } }, "pcIndexConfig": { "$ref": "#/components/schemas/AppWebIndexConfigRespVO" }, "appUrlConfig": { "$ref": "#/components/schemas/AppUrlConfigRespVO" }, "taxIdRequiredCountryCodes": { "type": "array", "description": "需要填写税号的国家代码列表，例如 US、DE、CN", "items": { "type": "string", "description": "需要填写税号的国家代码列表，例如 US、DE、CN" } }, "payCompletionPageConfig": { "$ref": "#/components/schemas/AppPayCompletionPageConfigRespVO" }, "userAddressConfigs": { "type": "array", "description": "用户地址配置列表，按国家配置税号标签和是否必填等信息", "items": { "$ref": "#/components/schemas/AppUserAddressConfig" } }, "newUserDiscountConfig": { "$ref": "#/components/schemas/NewUserDiscountConfigRespVO" }, "skipLoginConfig": { "$ref": "#/components/schemas/SkipLoginConfigRespVO" }, "pointConfig": { "$ref": "#/components/schemas/PointConfigRespVO" }, "pluginConfig": { "$ref": "#/components/schemas/PluginConfigRespVO" }, "forwardingWhiteList": { "type": "array", "description": "转运白名单", "items": { "type": "string", "description": "转运白名单" } } }, "description": "用户 APP - 应用配置信息 Response VO" }, "AppPayCompletionPageConfigRespVO": { "type": "object", "properties": { "freebagOrderEventEnabled": { "type": "boolean", "description": "是否启用抽包裹免单活动入口" }, "freebagOrderEventLink": { "type": "string", "description": "抽包裹免单link" }, "eggPrizeEnabled": { "type": "boolean", "description": "是否开启彩蛋中奖功能" }, "eggPrizeProbability": { "type": "number", "description": "彩蛋出现概率，单位：百分比（0-100），支持小数" }, "eggPrizeType": { "type": "string", "description": "彩蛋类型：SHIPPING_COUPON-运费券，PRODUCT_COUPON-商品券，WALLET_BALANCE-钱包余额" }, "eggPrizeRedeemCode": { "type": "string", "description": "彩蛋兑换码配置" } }, "description": "用户 APP - PC&APP支付完成页功能配置 Response VO" }, "AppUrlConfigRespVO": { "type": "object", "properties": { "discordSocialUrl": { "type": "string", "description": "discord社区打开地址链接" }, "rediditSocialUrl": { "type": "string", "description": "discord社区打开地址链接" }, "youtubeSocialUrl": { "type": "string", "description": "youtube社区打开地址链接" }, "facebookSocialUrl": { "type": "string", "description": "facebook社区打开地址链接" }, "tiktokSocialUrl": { "type": "string", "description": "tiktok社区打开地址链接" }, "telegeramSocialUrl": { "type": "string", "description": "telegeram社区打开地址链接" }, "linktreeSocialUrl": { "type": "string", "description": "linktree打开地址链接" }, "whatsappSocialUrl": { "type": "string", "description": "whatsapp打开地址链接" }, "instagramSocialUrl": { "type": "string", "description": "ins打开地址链接" } }, "description": "用户 APP - App相关链接配置 Response VO" }, "AppUserAddressConfig": { "type": "object", "properties": { "countryCode": { "type": "string" }, "taxLable": { "type": "string" }, "required": { "type": "boolean" } }, "description": "用户地址配置列表，按国家配置税号标签和是否必填等信息" }, "AppWebIndexConfigRespVO": { "type": "object", "properties": { "enabledServiceFeeDiscountCode": { "type": "boolean", "description": "是否开启服务费折扣码" }, "howToBuyFloatStatus": { "type": "integer", "description": "首页如何购买悬浮配置状态：1-保持悬浮，2-保持缩小，3-关闭卡片", "format": "int32" }, "indexThemeMode": { "type": "string", "description": "首页主题模式：DAILY-日常，HALLOWEEN-万圣节，BLACK_FRIDAY-黑五，CHRISTMAS-圣诞，CHRISTMAS_PREHEAT-圣诞活动预热，NEW_USER_DISCOUNT-新用户折扣，从 Apollo 配置 pc_power.index_theme.mode 获取，默认值：DAILY", "example": "DAILY" }, "enabledActivityEntry": { "type": "boolean", "description": "是否展示活动入口" }, "searchResultBannerConfig": { "$ref": "#/components/schemas/SearchResultBannerConfigVO" } }, "description": "用户 APP - App首页功能配置 Response VO" }, "CommonResultAppBasicConfigInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppBasicConfigInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NewUserDiscountBannerDynamicConfig": { "type": "object", "properties": { "subTotalAmt": { "type": "string" }, "newUserDiscount": { "type": "string" }, "totalAmt": { "type": "string" } } }, "NewUserDiscountConfigRespVO": { "type": "object", "properties": { "bannerDynamicDataConfig": { "$ref": "#/components/schemas/NewUserDiscountBannerDynamicConfig" }, "newDisCC": { "type": "string" } }, "description": "新用户折扣配置，包含首页 banner 动态数据配置（折扣值、小计金额、折后总金额等）" }, "PluginConfigRespVO": { "type": "object", "properties": { "googleExtensionZipDownloadUrl": { "type": "string", "description": "谷歌浏览器扩展（插件）压缩包下载地址，来自 Apollo app.plugin.google.extension.zip.url" } }, "description": "用户 APP - 浏览器插件相关配置 Response VO" }, "PointConfigRespVO": { "type": "object", "properties": { "pointDetailInfoId": { "type": "string", "description": "积分详情资讯 ID，用于跳转积分详情说明页面" } }, "description": "用户 APP - 积分配置 Response VO" }, "SearchResultBannerConfigVO": { "type": "object", "properties": { "redirectType": { "type": "integer", "description": "跳转类型：1-外部链接地址，2-内部页面（资讯中心）", "format": "int32", "nullable": true, "example": 1 }, "redirectValue": { "type": "string", "description": "跳转值：外部链接时为URL地址，内部页面时为页面标识", "nullable": true, "example": "https://example.com" } }, "description": "搜索结果页 banner 跳转配置", "nullable": true }, "SkipLoginConfigRespVO": { "type": "object", "properties": { "goodsDetailRnoValues": { "type": "array", "description": "商品详情页跳过登录的 rno 参数值列表，例如 [\"rno:frenchfish\"]", "items": { "type": "string", "description": "商品详情页跳过登录的 rno 参数值列表，例如 [\"rno:frenchfish\"]" } } }, "description": "用户 APP - 跳过登录配置 Response VO" }, "CommonResultUserProfileRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/UserProfileRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DeptSimpleRespVO": { "required": [ "id", "name", "parentId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "部门名称", "example": "芋道" }, "parentId": { "type": "integer", "description": "父部门 ID", "format": "int64", "example": 1024 } }, "description": "管理后台 - 部门精简信息 Response VO" }, "PostSimpleRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "岗位序号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "岗位名称", "example": "小土豆" } }, "description": "管理后台 - 岗位信息的精简 Response VO" }, "RoleSimpleRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "角色名称", "example": "芋道" } }, "description": "管理后台 - 角色精简信息 Response VO" }, "SocialUser": { "required": [ "openid", "type" ], "type": "object", "properties": { "type": { "type": "integer", "description": "社交平台的类型，参见 SocialTypeEnum 枚举类", "format": "int32", "example": 10 }, "openid": { "type": "string", "description": "社交用户的 openid", "example": "IPRmJ0wvBptiPIlGEZiPewGwiEiE" } }, "description": "社交用户" }, "UserProfileRespVO": { "required": [ "createTime", "id", "loginDate", "loginIp", "nickname", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1 }, "username": { "type": "string", "description": "用户账号", "example": "todo" }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋艿" }, "email": { "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xxx.png" }, "loginIp": { "type": "string", "description": "最后登录 IP", "example": "192.168.1.1" }, "loginDate": { "type": "string", "description": "最后登录时间", "format": "date-time" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSimpleRespVO" } }, "dept": { "$ref": "#/components/schemas/DeptSimpleRespVO" }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/PostSimpleRespVO" } }, "socialUsers": { "type": "array", "items": { "$ref": "#/components/schemas/SocialUser" } } }, "description": "管理后台 - 用户个人中心信息 Response VO" }, "UserPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "用户姓名", "example": "todo" }, "username": { "type": "string", "description": "用户账号，模糊匹配", "example": "todo" }, "mobile": { "type": "string", "description": "手机号码，模糊匹配", "example": "todo" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "example": "[2022-07-01 00:00:00, 2022-07-01 23:59:59]", "items": { "type": "string", "description": "创建时间", "format": "date-time" } }, "deptId": { "type": "integer", "description": "部门编号，同时筛选子部门", "format": "int64", "example": 1024 } }, "description": "管理后台 - 用户分页 Request VO" }, "CommonResultPageResultUserRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultUserRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultUserRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/UserRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "UserRespVO": { "required": [ "createTime", "id", "loginDate", "loginIp", "name", "nickname", "status", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1 }, "username": { "type": "string", "description": "用户账号", "example": "todo" }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋艿" }, "name": { "type": "string", "description": "真实姓名", "example": "芋艿" }, "remark": { "type": "string", "description": "备注", "example": "我是一个用户" }, "deptId": { "type": "integer", "description": "部门ID", "format": "int64" }, "deptName": { "type": "string", "description": "部门名称", "example": "IT 部" }, "postIds": { "uniqueItems": true, "type": "array", "description": "岗位编号数组", "example": 1, "items": { "type": "integer", "description": "岗位编号数组", "format": "int64", "example": 1 } }, "email": { "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xxx.png" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "loginIp": { "type": "string", "description": "最后登录 IP", "example": "192.168.1.1" }, "loginDate": { "type": "string", "description": "最后登录时间", "format": "date-time" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 用户信息 Response VO" }, "CommonResultListUserSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "UserSimpleRespVO": { "required": [ "id", "name", "nickname" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋道" }, "name": { "type": "string", "description": "姓名", "example": "芋道" }, "deptId": { "type": "integer", "description": "部门ID", "format": "int64" }, "deptName": { "type": "string", "description": "部门名称", "example": "IT 部" } }, "description": "管理后台 - 用户精简信息 Response VO" }, "CommonResultUserRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/UserRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "TenantPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "租户名", "example": "芋道" }, "contactName": { "type": "string", "description": "联系人", "example": "芋艿" }, "contactMobile": { "type": "string", "description": "联系手机", "example": "15601691300" }, "status": { "type": "integer", "description": "租户状态（0正常 1停用）", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 租户分页 Request VO" }, "CommonResultPageResultTenantRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultTenantRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultTenantRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/TenantRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "TenantRespVO": { "required": [ "accountCount", "contactName", "createTime", "expireTime", "id", "name", "packageId", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "租户编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "租户名", "example": "芋道" }, "contactName": { "type": "string", "description": "联系人", "example": "芋艿" }, "contactMobile": { "type": "string", "description": "联系手机", "example": "15601691300" }, "status": { "type": "integer", "description": "租户状态", "format": "int32", "example": 1 }, "website": { "type": "string", "description": "绑定域名", "example": "https://www.iocoder.cn" }, "packageId": { "type": "integer", "description": "租户套餐编号", "format": "int64", "example": 1024 }, "expireTime": { "type": "string", "description": "过期时间", "format": "date-time" }, "accountCount": { "type": "integer", "description": "账号数量", "format": "int32", "example": 1024 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 租户 Response VO" }, "CommonResultTenantRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/TenantRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultTenantSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/TenantSimpleRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "TenantSimpleRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "租户编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "租户名", "example": "芋道" } }, "description": "管理后台 - 租户精简 Response VO" }, "TenantPackagePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "套餐名", "example": "VIP" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "好" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 租户套餐分页 Request VO" }, "CommonResultPageResultTenantPackageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultTenantPackageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultTenantPackageRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/TenantPackageRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "TenantPackageRespVO": { "required": [ "createTime", "id", "menuIds", "name", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "套餐编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "套餐名", "example": "VIP" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "好" }, "menuIds": { "uniqueItems": true, "type": "array", "description": "关联的菜单编号", "items": { "type": "integer", "description": "关联的菜单编号", "format": "int64" } }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 租户套餐 Response VO" }, "CommonResultTenantPackageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/TenantPackageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListTenantPackageSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TenantPackageSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "TenantPackageSimpleRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "套餐编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "套餐名", "example": "VIP" } }, "description": "管理后台 - 租户套餐精简 Response VO" }, "SysShortLinkRecordPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "originalUrl": { "type": "string", "description": "原始链接，非空", "example": "https://www.iocoder.cn" }, "hashOriginalUrl": { "type": "string", "description": "原链hash值", "example": "https://www.iocoder.cn" }, "effective": { "type": "boolean", "description": "是否有效，防止链接泄露导致出现问题true有效，false失效" }, "saveClickRecord": { "type": "boolean", "description": "点击记录" }, "shortLinkKey": { "type": "string", "description": "短链接key或完整短链接（支持自动解析）", "example": "Iy0lllQZQ 或 https://qa.rizzitgo.link/Iy0lllQZQ" }, "remark": { "type": "string", "description": "备注", "example": "你猜" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } }, "groupId": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 }, "groupCode": { "type": "string", "description": "分组编码", "example": "DEFAULT" } }, "description": "管理后台 - 短链接记录分页 Request VO" }, "CommonResultPageResultSysShortLinkRecordRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSysShortLinkRecordRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSysShortLinkRecordRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SysShortLinkRecordRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SysShortLinkRecordRespVO": { "required": [ "createTime", "hashOriginalUrl", "id", "originalUrl", "shortLinkKey", "shortLinkUrl" ], "type": "object", "properties": { "originalUrl": { "type": "string", "description": "原始链接，非空", "example": "https://www.iocoder.cn" }, "shortLinkUrl": { "type": "string", "description": "短链地址" }, "shortLinkClickCount": { "type": "integer", "description": "短链点击次数", "format": "int64" }, "groupId": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 }, "groupName": { "type": "string", "description": "分组名称", "example": "默认分组" }, "groupCode": { "type": "string", "description": "分组编码", "example": "DEFAULT" }, "remark": { "type": "string", "description": "备注", "example": "你猜" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "id": { "type": "integer", "description": "数据id", "format": "int64", "example": 26759 }, "hashOriginalUrl": { "type": "string", "description": "原链hash值", "example": "https://www.iocoder.cn" }, "effective": { "type": "boolean", "description": "是否有效，防止链接泄露导致出现问题true有效，false失效" }, "saveClickRecord": { "type": "boolean", "description": "点击记录" }, "shortLinkKey": { "type": "string", "description": "短链接key，长度32，非空，唯一" } }, "description": "管理后台 - 短链接记录 Response VO" }, "CommonResultSysShortLinkRecordRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SysShortLinkRecordRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SysShortLinkDailyClickReqVO": { "required": [ "shortLinkKey" ], "type": "object", "properties": { "shortLinkKey": { "type": "string", "description": "短链key", "example": "Iy0lllQZQ" }, "startDate": { "type": "string", "description": "开始日期", "format": "date", "example": "2024-01-01" }, "endDate": { "type": "string", "description": "结束日期", "format": "date", "example": "2024-01-31" } }, "description": "管理后台 - 短链接每日点击统计 Request VO" }, "CommonResultListSysShortLinkDailyClickRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SysShortLinkDailyClickRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SysShortLinkDailyClickRespVO": { "required": [ "clickCount", "date" ], "type": "object", "properties": { "date": { "type": "string", "description": "日期", "format": "date", "example": "2024-01-15" }, "clickCount": { "type": "integer", "description": "点击次数", "format": "int64", "example": 125 } }, "description": "管理后台 - 短链接每日点击统计 Response VO" }, "SupportInfoPageReqVO": { "required": [ "classifyUuid", "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "title": { "type": "string", "description": "标题" }, "classifyId": { "type": "integer", "description": "分类id", "format": "int64", "example": 22436 }, "classifyUuid": { "type": "string", "description": "分类uuid", "example": "22436" }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型21:PC 31:APP", "format": "int32", "example": 2 }, "status": { "type": "integer", "description": "状态（0正常 1关闭）", "format": "int32", "example": 2 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 帮助中心信息分页 Request VO" }, "CommonResultPageResultSupportInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSupportInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSupportInfoRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SupportInfoRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SupportInfoRespVO": { "required": [ "classifyId", "classifyName", "classifyUuid", "content", "createTime", "hot", "id", "language", "status", "terminalType", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 24031 }, "uuidCode": { "type": "string", "description": "uuidcode", "example": "24031" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "classifyId": { "type": "integer", "description": "分类id", "format": "int64", "example": 22436 }, "classifyUuid": { "type": "string", "description": "分类uuid", "example": "22436" }, "classifyName": { "type": "string", "description": "归属分类", "example": "22436" }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "terminalType": { "type": "integer", "description": "终端类型21:PC 31:APP", "format": "int32", "example": 2 }, "sort": { "type": "integer", "description": "排序-升序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1关闭）", "format": "int32", "example": 2 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "hot": { "type": "boolean", "description": "是否热门问题", "example": false } }, "description": "管理后台 - 帮助中心信息 Response VO" }, "CommonResultSupportInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SupportInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListSupportInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SupportInfoRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialUserPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "type": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 30 }, "nickname": { "type": "string", "description": "用户昵称", "example": "李四" }, "openid": { "type": "string", "description": "社交 openid", "example": "oz-Jdt0kd_jdhUxJHQdBJMlOFN7w" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 社交用户分页 Request VO" }, "CommonResultPageResultSocialUserRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSocialUserRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSocialUserRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SocialUserRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SocialUserRespVO": { "required": [ "code", "createTime", "id", "nickname", "openid", "rawTokenInfo", "rawUserInfo", "state", "token", "type", "updateTime" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键(自增策略)", "format": "int64", "example": 14569 }, "type": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 30 }, "openid": { "type": "string", "description": "社交 openid（查询接口脱敏）", "example": "oAB****xyz" }, "token": { "type": "string", "description": "社交 token（查询接口脱敏）", "example": "******" }, "rawTokenInfo": { "type": "string", "description": "原始 Token 数据（查询接口脱敏）", "example": "******" }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋艿" }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xxx.png" }, "rawUserInfo": { "type": "string", "description": "原始用户数据（查询接口脱敏）", "example": "******" }, "code": { "type": "string", "description": "最后一次的认证 code（查询接口脱敏）", "example": "******" }, "state": { "type": "string", "description": "最后一次的认证 state", "example": "123456" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "管理后台 - 社交用户 Response VO" }, "CommonResultSocialUserRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SocialUserRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialClientPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "应用名", "example": "todo商城" }, "socialType": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 31 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 2 }, "clientId": { "type": "string", "description": "客户端编号", "example": "145442115" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 } }, "description": "管理后台 - 社交客户端分页 Request VO" }, "CommonResultPageResultSocialClientRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSocialClientRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSocialClientRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SocialClientRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SocialClientRespVO": { "required": [ "agentId", "clientId", "clientSecret", "createTime", "id", "name", "socialType", "status", "userType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 27162 }, "name": { "type": "string", "description": "应用名", "example": "todo商城" }, "socialType": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 31 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 2 }, "clientId": { "type": "string", "description": "客户端编号（查询接口脱敏展示）", "example": "wwd****2e54" }, "clientSecret": { "type": "string", "description": "客户端密钥（查询接口脱敏展示，非明文）", "example": "******" }, "agentId": { "type": "string", "description": "授权方的网页应用编号", "example": "2000045" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 社交客户端 Response VO" }, "CommonResultSocialClientRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SocialClientRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SmsTemplatePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "type": { "type": "integer", "description": "短信签名", "format": "int32", "example": 1 }, "status": { "type": "integer", "description": "开启状态", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "模板编码，模糊匹配", "example": "test_01" }, "content": { "type": "string", "description": "模板内容，模糊匹配", "example": "你好，{name}。你长的太{like}啦！" }, "apiTemplateId": { "type": "string", "description": "短信 API 的模板编号，模糊匹配", "example": "4383920" }, "channelId": { "type": "integer", "description": "短信渠道编号", "format": "int64", "example": 10 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 短信模板分页 Request VO" }, "CommonResultPageResultSmsTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSmsTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSmsTemplateRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SmsTemplateRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SmsTemplateRespVO": { "required": [ "apiTemplateId", "channelCode", "channelId", "code", "content", "createTime", "id", "name", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "type": { "type": "integer", "description": "短信类型，参见 SmsTemplateTypeEnum 枚举类", "format": "int32", "example": 1 }, "status": { "type": "integer", "description": "开启状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "模板编码", "example": "test_01" }, "name": { "type": "string", "description": "模板名称", "example": "todo" }, "content": { "type": "string", "description": "模板内容", "example": "你好，{name}。你长的太{like}啦！" }, "params": { "type": "array", "description": "参数数组", "example": "name,code", "items": { "type": "string", "description": "参数数组", "example": "name,code" } }, "remark": { "type": "string", "description": "备注", "example": "哈哈哈" }, "apiTemplateId": { "type": "string", "description": "短信 API 的模板编号", "example": "4383920" }, "channelId": { "type": "integer", "description": "短信渠道编号", "format": "int64", "example": 10 }, "channelCode": { "type": "string", "description": "短信渠道编码", "example": "ALIYUN" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 短信模板 Response VO" }, "CommonResultSmsTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SmsTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SmsLogPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "channelId": { "type": "integer", "description": "短信渠道编号", "format": "int64", "example": 10 }, "templateId": { "type": "integer", "description": "模板编号", "format": "int64", "example": 20 }, "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "sendStatus": { "type": "integer", "description": "发送状态，参见 SmsSendStatusEnum 枚举类", "format": "int32", "example": 1 }, "sendTime": { "type": "array", "description": "发送时间", "items": { "type": "string", "description": "发送时间", "format": "date-time" } }, "receiveStatus": { "type": "integer", "description": "接收状态，参见 SmsReceiveStatusEnum 枚举类", "format": "int32", "example": 0 }, "receiveTime": { "type": "array", "description": "接收时间", "items": { "type": "string", "description": "接收时间", "format": "date-time" } } }, "description": "管理后台 - 短信日志分页 Request VO" }, "CommonResultPageResultSmsLogRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSmsLogRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSmsLogRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SmsLogRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SmsLogRespVO": { "required": [ "apiTemplateId", "channelCode", "channelId", "createTime", "id", "mobile", "receiveStatus", "sendStatus", "templateCode", "templateContent", "templateId", "templateParams", "templateType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "channelId": { "type": "integer", "description": "短信渠道编号", "format": "int64", "example": 10 }, "channelCode": { "type": "string", "description": "短信渠道编码", "example": "ALIYUN" }, "templateId": { "type": "integer", "description": "模板编号", "format": "int64", "example": 20 }, "templateCode": { "type": "string", "description": "模板编码", "example": "test-01" }, "templateType": { "type": "integer", "description": "短信类型", "format": "int32", "example": 1 }, "templateContent": { "type": "string", "description": "短信内容", "example": "你好，你的验证码是 1024" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "短信参数", "example": "name,code" }, "description": "短信参数", "example": "name,code" }, "apiTemplateId": { "type": "string", "description": "短信 API 的模板编号", "example": "SMS_207945135" }, "mobile": { "type": "string", "description": "手机号", "example": "15601691300" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 10 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "sendStatus": { "type": "integer", "description": "发送状态", "format": "int32", "example": 1 }, "sendTime": { "type": "string", "description": "发送时间", "format": "date-time" }, "apiSendCode": { "type": "string", "description": "短信 API 发送结果的编码", "example": "SUCCESS" }, "apiSendMsg": { "type": "string", "description": "短信 API 发送失败的提示", "example": "成功" }, "apiRequestId": { "type": "string", "description": "短信 API 发送返回的唯一请求 ID", "example": "3837C6D3-B96F-428C-BBB2-86135D4B5B99" }, "apiSerialNo": { "type": "string", "description": "短信 API 发送返回的序号", "example": "62923244790" }, "receiveStatus": { "type": "integer", "description": "接收状态", "format": "int32", "example": 0 }, "receiveTime": { "type": "string", "description": "接收时间", "format": "date-time" }, "apiReceiveCode": { "type": "string", "description": "API 接收结果的编码", "example": "DELIVRD" }, "apiReceiveMsg": { "type": "string", "description": "API 接收结果的说明", "example": "用户接收成功" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 短信日志 Response VO" }, "SmsChannelPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "status": { "type": "integer", "description": "任务状态", "format": "int32", "example": 1 }, "signature": { "type": "string", "description": "短信签名，模糊匹配", "example": "芋道源码" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 短信渠道分页 Request VO" }, "CommonResultPageResultSmsChannelRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSmsChannelRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSmsChannelRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SmsChannelRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SmsChannelRespVO": { "required": [ "apiKey", "code", "createTime", "id", "signature", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "signature": { "type": "string", "description": "短信签名", "example": "芋道源码" }, "code": { "type": "string", "description": "渠道编码，参见 SmsChannelEnum 枚举类", "example": "YUN_PIAN" }, "status": { "type": "integer", "description": "启用状态", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "好吃！" }, "apiKey": { "type": "string", "description": "短信 API 的账号；查询接口脱敏展示", "example": "todo" }, "apiSecret": { "type": "string", "description": "短信 API 的密钥；查询接口脱敏展示", "example": "******" }, "callbackUrl": { "type": "string", "description": "短信发送回调 URL", "example": "https://www.iocoder.cn" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 短信渠道 Response VO" }, "CommonResultListSmsChannelSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SmsChannelSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SmsChannelSimpleRespVO": { "required": [ "code", "id", "signature" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "signature": { "type": "string", "description": "短信签名", "example": "芋道源码" }, "code": { "type": "string", "description": "渠道编码，参见 SmsChannelEnum 枚举类", "example": "YUN_PIAN" } }, "description": "管理后台 - 短信渠道精简 Response VO" }, "CommonResultSmsChannelRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SmsChannelRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SysShortLinkGroupPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "groupName": { "type": "string", "description": "分组名称", "example": "默认分组" }, "groupCode": { "type": "string", "description": "分组编码", "example": "DEFAULT" } }, "description": "管理后台 - 短链分组分页 Request VO" }, "CommonResultPageResultSysShortLinkGroupRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSysShortLinkGroupRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSysShortLinkGroupRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SysShortLinkGroupRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SysShortLinkGroupRespVO": { "required": [ "createTime", "groupName", "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 }, "groupName": { "type": "string", "description": "分组名称", "example": "默认分组" }, "groupCode": { "type": "string", "description": "分组编码，唯一标识该分组", "example": "DEFAULT" }, "sort": { "type": "integer", "description": "排序值，越小越靠前", "format": "int32", "example": 0 }, "description": { "type": "string", "description": "分组描述", "example": "默认分组描述" }, "remark": { "type": "string", "description": "备注信息", "example": "备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "linkCount": { "type": "integer", "description": "关联短链数量", "format": "int64", "example": 10 }, "totalClickCount": { "type": "integer", "description": "总点击次数", "format": "int64", "example": 100 } }, "description": "管理后台 - 短链分组 Response VO" }, "CommonResultSysShortLinkGroupRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SysShortLinkGroupRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SysShortLinkGroupDailyClickReqVO": { "required": [ "groupId" ], "type": "object", "properties": { "groupId": { "type": "integer", "description": "分组ID", "format": "int64", "example": 1 }, "startDate": { "type": "string", "description": "开始日期", "format": "date", "example": "2024-01-01" }, "endDate": { "type": "string", "description": "结束日期", "format": "date", "example": "2024-01-31" } }, "description": "管理后台 - 分组下短链每日点击统计 Request VO" }, "CommonResultListSysShortLinkGroupDailyClickRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SysShortLinkGroupDailyClickRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SysShortLinkGroupDailyClickRespVO": { "required": [ "id", "originalUrl", "shortLinkKey", "shortLinkUrl" ], "type": "object", "properties": { "id": { "type": "integer", "description": "短链记录ID", "format": "int64", "example": 1 }, "shortLinkKey": { "type": "string", "description": "短链Key", "example": "Iy0lllQZQ" }, "originalUrl": { "type": "string", "description": "原始链接", "example": "https://www.example.com" }, "shortLinkUrl": { "type": "string", "description": "短链地址", "example": "https://short.link/Iy0lllQZQ" }, "remark": { "type": "string", "description": "备注", "example": "测试链接" }, "dailyClickStats": { "type": "array", "description": "每日点击统计列表", "items": { "$ref": "#/components/schemas/SysShortLinkDailyClickRespVO" } } }, "description": "管理后台 - 分组下短链每日点击统计 Response VO" }, "SensitiveWordPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "敏感词", "example": "敏感词" }, "tag": { "type": "string", "description": "标签", "example": "短信,评论" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 敏感词分页 Request VO" }, "CommonResultPageResultSensitiveWordRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSensitiveWordRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSensitiveWordRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SensitiveWordRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SensitiveWordRespVO": { "required": [ "createTime", "id", "name", "status", "tags" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "敏感词", "example": "敏感词" }, "tags": { "type": "array", "description": "标签", "example": "短信,评论", "items": { "type": "string", "description": "标签", "example": "短信,评论" } }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "description": { "type": "string", "description": "描述", "example": "污言秽语" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 敏感词 Response VO" }, "CommonResultSensitiveWordRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SensitiveWordRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultSetString": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultPageResultRoleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultRoleRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultRoleRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/RoleRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "RoleRespVO": { "required": [ "code", "createTime", "dataScope", "id", "name", "sort", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "角色编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "角色名称", "example": "管理员" }, "code": { "type": "string" }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "type": { "type": "integer", "description": "角色类型，参见 RoleTypeEnum 枚举类", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "我是一个角色" }, "dataScope": { "type": "integer", "description": "数据范围，参见 DataScopeEnum 枚举类", "format": "int32", "example": 1 }, "dataScopeDeptIds": { "uniqueItems": true, "type": "array", "description": "数据范围(指定部门数组)", "example": 1, "items": { "type": "integer", "description": "数据范围(指定部门数组)", "format": "int64", "example": 1 } }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 角色信息 Response VO" }, "CommonResultListRoleSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultRoleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/RoleRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "RolePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "角色名称，模糊匹配", "example": "芋道" }, "code": { "type": "string", "description": "角色标识，模糊匹配", "example": "todo" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "example": "[2022-07-01 00:00:00,2022-07-01 23:59:59]", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 角色分页 Request VO" }, "AdminRsaPublicKeyRespVO": { "type": "object", "properties": { "rsaKeyId": { "type": "string", "description": "RSA 密钥版本标识", "example": "rsa-v1" }, "rsaPublicKey": { "type": "string", "description": "RSA 公钥（X.509, Base64 编码）" } }, "description": "管理后台 - RSA 公钥 Response VO" }, "CommonResultAdminRsaPublicKeyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AdminRsaPublicKeyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "ProtocolStatementPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "title": { "type": "string", "description": "标题" }, "positionType": { "type": "integer", "description": "职责类型 1：登录页 2：注册页 3：结算页 4：提包页面 5：物流航线", "format": "int32", "example": 2 }, "language": { "type": "string", "description": "语言" }, "status": { "type": "boolean", "description": "状态", "example": false }, "recommend": { "type": "boolean", "description": "是否推介阅读 0 否 1是" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 平台协议声明分页 Request VO" }, "CommonResultPageResultProtocolStatementRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultProtocolStatementRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultProtocolStatementRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/ProtocolStatementRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "ProtocolStatementRespVO": { "required": [ "content", "createTime", "id", "language", "positionType", "status", "title", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 29647 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "29647" }, "title": { "type": "string", "description": "标题" }, "content": { "type": "string", "description": "内容" }, "positionType": { "type": "integer", "description": "职责类型 1：登录页 2：注册页 3：结算页 4：提包页面 5：物流航线", "format": "int32", "example": 2 }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "boolean", "description": "状态", "example": false }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 平台协议声明 Response VO" }, "CommonResultProtocolStatementRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/ProtocolStatementRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListProtocolStatementRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProtocolStatementRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PostPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "code": { "type": "string", "description": "岗位编码，模糊匹配", "example": "todo" }, "name": { "type": "string", "description": "岗位名称，模糊匹配", "example": "芋道" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 岗位分页 Request VO" }, "CommonResultPageResultPostRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultPostRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultPostRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/PostRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "PostRespVO": { "required": [ "code", "createTime", "id", "name", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "岗位序号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "岗位名称", "example": "小土豆" }, "code": { "type": "string", "description": "岗位编码", "example": "todo" }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "快乐的备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 岗位信息 Response VO" }, "CommonResultListPostSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PostSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultPostRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PostRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OperateLogPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "module": { "type": "string", "description": "操作模块，模拟匹配", "example": "订单" }, "userNickname": { "type": "string", "description": "用户昵称，模拟匹配", "example": "芋道" }, "type": { "type": "integer", "description": "操作分类，参见 OperateLogTypeEnum 枚举类", "format": "int32", "example": 1 }, "success": { "type": "boolean", "description": "操作状态", "example": true }, "startTime": { "type": "array", "description": "开始时间", "example": "[2022-07-01 00:00:00,2022-07-01 23:59:59]", "items": { "type": "string", "description": "开始时间", "format": "date-time" } } }, "description": "管理后台 - 操作日志分页列表 Request VO" }, "CommonResultPageResultOperateLogRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultOperateLogRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OperateLogRespVO": { "required": [ "duration", "id", "javaMethod", "module", "name", "requestMethod", "requestUrl", "resultCode", "startTime", "traceId", "type", "userAgent", "userId", "userIp", "userNickname" ], "type": "object", "properties": { "id": { "type": "integer", "description": "日志编号", "format": "int64", "example": 1024 }, "traceId": { "type": "string", "description": "链路追踪编号", "example": "89aca178-a370-411c-ae02-3f0d672be4ab" }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userNickname": { "type": "string", "description": "用户昵称", "example": "芋艿" }, "module": { "type": "string", "description": "操作模块", "example": "订单" }, "name": { "type": "string", "description": "操作名", "example": "创建订单" }, "type": { "type": "integer", "description": "操作分类，参见 OperateLogTypeEnum 枚举类", "format": "int32", "example": 1 }, "content": { "type": "string", "description": "操作明细；超长时截断脱敏", "example": "修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。" }, "exts": { "type": "object", "additionalProperties": { "type": "object", "description": "拓展字段", "example": "{'orderId': 1}" }, "description": "拓展字段", "example": "{'orderId': 1}" }, "requestMethod": { "type": "string", "description": "请求方法名", "example": "GET" }, "requestUrl": { "type": "string", "description": "请求地址", "example": "/xxx/yyy" }, "userIp": { "type": "string", "description": "用户 IP", "example": "127.0.0.1" }, "userAgent": { "type": "string", "description": "浏览器 UserAgent", "example": "Mozilla/5.0" }, "javaMethod": { "type": "string", "description": "Java 方法名", "example": "com.todo.buy.adminserver.UserController.save(...)" }, "javaMethodArgs": { "type": "string", "description": "Java 方法的参数；查询/导出为脱敏占位" }, "startTime": { "type": "string", "description": "开始时间", "format": "date-time" }, "duration": { "type": "integer", "description": "执行时长，单位：毫秒", "format": "int32" }, "resultCode": { "type": "integer", "description": "结果码", "format": "int32" }, "resultMsg": { "type": "string", "description": "结果提示" }, "resultData": { "type": "string", "description": "结果数据；查询/导出为脱敏占位" } }, "description": "管理后台 - 操作日志 Response VO" }, "PageResultOperateLogRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/OperateLogRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultOAuth2UserInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/OAuth2UserInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "Dept": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "部门名称", "example": "研发部" } }, "description": "部门" }, "OAuth2UserInfoRespVO": { "required": [ "id", "nickname", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1 }, "username": { "type": "string", "description": "用户账号", "example": "芋艿" }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋道" }, "email": { "type": "string", "description": "用户邮箱", "example": "todo@iocoder.cn" }, "mobile": { "type": "string", "description": "手机号码", "example": "15601691300" }, "sex": { "type": "integer", "description": "用户性别，参见 SexEnum 枚举类", "format": "int32", "example": 1 }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xxx.png" }, "dept": { "$ref": "#/components/schemas/Dept" }, "posts": { "type": "array", "items": { "$ref": "#/components/schemas/Post" } } }, "description": "管理后台 - OAuth2 获得用户基本信息 Response VO" }, "Post": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "岗位编号", "format": "int64", "example": 1 }, "name": { "type": "string", "description": "岗位名称", "example": "开发" } }, "description": "岗位" }, "OAuth2ClientPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "应用名，模糊匹配", "example": "土豆" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "partnerName": { "type": "string", "description": "合作方名称，模糊匹配（开放平台）", "example": "顺丰" }, "grantType": { "type": "string", "description": "授权类型过滤；开放平台合作方应用列表传 client_credentials 仅展示合作方应用", "example": "client_credentials" } }, "description": "管理后台 - OAuth2 客户端分页 Request VO" }, "CommonResultPageResultOAuth2ClientRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultOAuth2ClientRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "OAuth2ClientRespVO": { "required": [ "accessTokenValiditySeconds", "authorizedGrantTypes", "clientId", "createTime", "id", "logo", "name", "redirectUris", "refreshTokenValiditySeconds", "secret", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "clientId": { "type": "string", "description": "客户端编号", "example": "tudou" }, "secret": { "type": "string", "description": "客户端密钥；查询接口脱敏展示", "example": "******" }, "name": { "type": "string", "description": "应用名", "example": "土豆" }, "logo": { "type": "string", "description": "应用图标", "example": "https://www.iocoder.cn/xx.png" }, "description": { "type": "string", "description": "应用描述", "example": "我是一个应用" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "accessTokenValiditySeconds": { "type": "integer", "description": "访问令牌的有效期", "format": "int32", "example": 8640 }, "refreshTokenValiditySeconds": { "type": "integer", "description": "刷新令牌的有效期", "format": "int32", "example": 8640000 }, "redirectUris": { "type": "array", "description": "可重定向的 URI 地址", "example": "https://www.iocoder.cn", "items": { "type": "string", "description": "可重定向的 URI 地址", "example": "https://www.iocoder.cn" } }, "authorizedGrantTypes": { "type": "array", "description": "授权类型，参见 OAuth2GrantTypeEnum 枚举", "example": "password", "items": { "type": "string", "description": "授权类型，参见 OAuth2GrantTypeEnum 枚举", "example": "password" } }, "scopes": { "type": "array", "description": "授权范围", "example": "user_info", "items": { "type": "string", "description": "授权范围", "example": "user_info" } }, "autoApproveScopes": { "type": "array", "description": "自动通过的授权范围", "example": "user_info", "items": { "type": "string", "description": "自动通过的授权范围", "example": "user_info" } }, "authorities": { "type": "array", "description": "权限", "example": "system:user:query", "items": { "type": "string", "description": "权限", "example": "system:user:query" } }, "resourceIds": { "type": "array", "description": "资源", "example": 1024, "items": { "type": "string", "description": "资源", "example": "1024" } }, "additionalInformation": { "type": "string", "description": "附加信息", "example": "{yunai: true}" }, "partnerName": { "type": "string", "description": "合作方名称（开放平台运营展示）", "example": "顺丰国际" }, "partnerContact": { "type": "string", "description": "合作方联系人（开放平台）", "example": "张三 / zhangsan@xx.com" }, "ipWhitelist": { "type": "string", "description": "IP 白名单，逗号分隔；为空不限制（开放平台）", "example": "1.1.1.1,2.2.2.2" }, "rateLimitQps": { "type": "integer", "description": "每秒限流 QPS；0 表示不限流（开放平台）", "format": "int32", "example": 50 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - OAuth2 客户端 Response VO" }, "PageResultOAuth2ClientRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/OAuth2ClientRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultOAuth2ClientRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/OAuth2ClientRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyTemplatePageReqVO": { "required": [ "languageCode", "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "code": { "type": "string", "description": "模版编码", "example": "test_01" }, "name": { "type": "string", "description": "模版名称", "example": "我是名称" }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "SEND_TEST" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "type": { "type": "integer", "description": "消息类型", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 站内信模版分页 Request VO" }, "CommonResultPageResultNotifyTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultNotifyTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyTemplateRespVO": { "required": [ "code", "content", "createTime", "id", "languageCode", "name", "nickname", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "模版名称", "example": "测试模版" }, "code": { "type": "string", "description": "模版编码", "example": "SEND_TEST" }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "SEND_TEST" }, "type": { "type": "integer", "description": "模版类型，对应 system_notify_template_type 字典", "format": "int32", "example": 1 }, "nickname": { "type": "string", "description": "发送人名称", "example": "土豆" }, "content": { "type": "string", "description": "模版内容", "example": "我是模版内容" }, "params": { "type": "array", "description": "参数数组", "example": "name,code", "items": { "type": "string", "description": "参数数组", "example": "name,code" } }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "我是备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 站内信模版 Response VO" }, "PageResultNotifyTemplateRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/NotifyTemplateRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultNotifyTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NotifyTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyMessagePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 25025 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "templateCode": { "type": "string", "description": "模板编码", "example": "test_01" }, "templateType": { "type": "integer", "description": "模版类型", "format": "int32", "example": 2 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 站内信分页 Request VO" }, "CommonResultPageResultNotifyMessageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultNotifyMessageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NotifyMessageRespVO": { "required": [ "createTime", "id", "readStatus", "templateCode", "templateContent", "templateId", "templateNickname", "templateParams", "templateType", "userId", "userType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 1024 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 25025 }, "userType": { "type": "string", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "byte", "example": "MQ==" }, "templateId": { "type": "integer", "description": "模版编号", "format": "int64", "example": 13013 }, "templateCode": { "type": "string", "description": "模板编码", "example": "test_01" }, "templateNickname": { "type": "string", "description": "模版发送人名称", "example": "芋艿" }, "templateContent": { "type": "string", "description": "模版内容", "example": "测试内容" }, "templateType": { "type": "integer", "description": "模版类型", "format": "int32", "example": 2 }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "模版参数" }, "description": "模版参数" }, "readStatus": { "type": "boolean", "description": "是否已读", "example": true }, "readTime": { "type": "string", "description": "阅读时间", "format": "date-time" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 站内信 Response VO" }, "PageResultNotifyMessageRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/NotifyMessageRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "NotifyMessageMyPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "readStatus": { "type": "boolean", "description": "是否已读", "example": true }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } }, "templateType": { "type": "integer", "format": "int32" }, "keyword": { "type": "string", "description": "站内信搜索关键字", "nullable": true, "example": "12345" } }, "description": "管理后台 - 站内信分页 Request VO" }, "CommonResultNotifyMessageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NotifyMessageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListNotifyMessageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotifyMessageRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NoticePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "title": { "type": "string", "description": "通知公告名称，模糊匹配", "example": "芋道" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 通知公告分页 Request VO" }, "CommonResultPageResultNoticeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultNoticeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "NoticeRespVO": { "required": [ "content", "createTime", "id", "status", "title", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "通知公告序号", "format": "int64", "example": 1024 }, "title": { "type": "string", "description": "公告标题", "example": "小博主" }, "type": { "type": "integer", "description": "公告类型", "format": "int32" }, "content": { "type": "string", "description": "公告内容", "example": "半生编码" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 通知公告信息 Response VO" }, "PageResultNoticeRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/NoticeRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultNoticeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/NoticeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListMenuRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MenuRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MenuRespVO": { "required": [ "createTime", "id", "name", "parentId", "sort", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "菜单编号", "format": "int64", "example": 1024 }, "name": { "maxLength": 50, "minLength": 0, "type": "string", "description": "菜单名称", "example": "芋道" }, "permission": { "maxLength": 100, "minLength": 0, "type": "string", "description": "权限标识,仅菜单类型为按钮时，才需要传递", "example": "sys:menu:add" }, "type": { "type": "integer", "description": "类型，参见 MenuTypeEnum 枚举类", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "parentId": { "type": "integer", "description": "父菜单 ID", "format": "int64", "example": 1024 }, "path": { "maxLength": 200, "minLength": 0, "type": "string", "description": "路由地址,仅菜单类型为菜单或者目录时，才需要传", "example": "post" }, "icon": { "type": "string", "description": "菜单图标,仅菜单类型为菜单或者目录时，才需要传", "example": "/menu/list" }, "component": { "maxLength": 200, "minLength": 0, "type": "string", "description": "组件路径,仅菜单类型为菜单时，才需要传", "example": "system/post/index" }, "componentName": { "type": "string", "description": "组件名", "example": "SystemUser" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "visible": { "type": "boolean", "description": "是否可见", "example": false }, "keepAlive": { "type": "boolean", "description": "是否缓存", "example": false }, "alwaysShow": { "type": "boolean", "description": "是否总是显示", "example": false }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 菜单信息 Response VO" }, "CommonResultListMenuSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MenuSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MenuSimpleRespVO": { "required": [ "id", "name", "parentId", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "菜单编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "菜单名称", "example": "芋道" }, "parentId": { "type": "integer", "description": "父菜单 ID", "format": "int64", "example": 1024 }, "type": { "type": "integer", "description": "类型，参见 MenuTypeEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 菜单精简信息 Response VO" }, "CommonResultMenuRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/MenuRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailTemplatePageReqVO": { "required": [ "languageCode", "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "code": { "type": "string", "description": "标识，模糊匹配", "example": "code_1024" }, "name": { "type": "string", "description": "名称，模糊匹配", "example": "芋头" }, "accountId": { "type": "integer", "description": "账号编号", "format": "int64", "example": 2048 }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "test" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 邮件模版分页 Request VO" }, "CommonResultPageResultMailTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultMailTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailTemplateRespVO": { "required": [ "accountId", "code", "content", "createTime", "id", "languageCode", "name", "status", "title" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "模版名称", "example": "测试名字" }, "code": { "type": "string", "description": "模版编号", "example": "test" }, "languageCode": { "type": "string", "description": "模版国际化编码", "example": "SEND_TEST" }, "accountId": { "type": "integer", "description": "发送的邮箱账号编号", "format": "int64", "example": 1 }, "nickname": { "type": "string", "description": "发送人名称", "example": "芋头" }, "title": { "type": "string", "description": "标题", "example": "注册成功" }, "content": { "type": "string", "description": "内容", "example": "你好，注册成功啦" }, "params": { "type": "array", "description": "参数数组", "example": "name,code", "items": { "type": "string", "description": "参数数组", "example": "name,code" } }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "奥特曼" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 邮件末班 Response VO" }, "PageResultMailTemplateRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/MailTemplateRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultListMailTemplateSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailTemplateSimpleRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "模版编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "模版名字", "example": "哒哒哒" } }, "description": "管理后台 - 邮件模版的精简 Response VO" }, "CommonResultMailTemplateRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/MailTemplateRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailLogPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 30883 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 2 }, "toMail": { "type": "string", "description": "接收邮箱地址，模糊匹配", "example": "76854@qq.com" }, "accountId": { "type": "integer", "description": "邮箱账号编号", "format": "int64", "example": 18107 }, "templateId": { "type": "integer", "description": "模板编号", "format": "int64", "example": 5678 }, "sendStatus": { "type": "integer", "description": "发送状态，参见 MailSendStatusEnum 枚举", "format": "int32", "example": 1 }, "sendTime": { "type": "array", "description": "发送时间", "items": { "type": "string", "description": "发送时间", "format": "date-time" } } }, "description": "管理后台 - 邮箱日志分页 Request VO" }, "CommonResultPageResultMailLogRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultMailLogRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailLogRespVO": { "required": [ "accountId", "createTime", "fromMail", "id", "sendStatus", "templateCode", "templateContent", "templateId", "templateParams", "templateTitle", "toMail" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 31020 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 30883 }, "userType": { "type": "string", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "byte", "example": "Mg==" }, "toMail": { "type": "string", "description": "接收邮箱地址", "example": "76854@qq.com" }, "accountId": { "type": "integer", "description": "邮箱账号编号", "format": "int64", "example": 18107 }, "fromMail": { "type": "string", "description": "发送邮箱地址", "example": "85757@qq.com" }, "templateId": { "type": "integer", "description": "模板编号", "format": "int64", "example": 5678 }, "templateCode": { "type": "string", "description": "模板编码", "example": "test_01" }, "templateNickname": { "type": "string", "description": "模版发送人名称", "example": "李四" }, "templateTitle": { "type": "string", "description": "邮件标题", "example": "测试标题" }, "templateContent": { "type": "string", "description": "邮件内容", "example": "测试内容" }, "templateParams": { "type": "object", "additionalProperties": { "type": "object", "description": "邮件参数" }, "description": "邮件参数" }, "sendStatus": { "type": "string", "description": "发送状态，参见 MailSendStatusEnum 枚举", "format": "byte", "example": "MQ==" }, "sendTime": { "type": "string", "description": "发送时间", "format": "date-time" }, "sendMessageId": { "type": "string", "description": "发送返回的消息 ID", "example": "28568" }, "sendException": { "type": "string", "description": "发送异常" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 邮件日志 Response VO" }, "PageResultMailLogRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/MailLogRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultMailLogRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/MailLogRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailAccountPageReqVO": { "required": [ "mail", "pageNo", "pageSize", "username" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "mail": { "type": "string", "description": "邮箱", "example": "todoyuanma@123.com" }, "username": { "type": "string", "description": "用户名", "example": "todo" } }, "description": "管理后台 - 邮箱账号分页 Request VO" }, "CommonResultPageResultMailAccountRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultMailAccountRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailAccountRespVO": { "required": [ "createTime", "host", "id", "mail", "password", "port", "sslEnable", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "mail": { "type": "string", "description": "邮箱；查询接口脱敏展示", "example": "to****a@qq.com" }, "username": { "type": "string", "description": "用户名；查询接口脱敏展示", "example": "t****o" }, "password": { "type": "string", "description": "密码；查询接口脱敏展示", "example": "******" }, "host": { "type": "string", "description": "SMTP 服务器域名", "example": "www.iocoder.cn" }, "port": { "type": "integer", "description": "SMTP 服务器端口", "format": "int32", "example": 80 }, "sslEnable": { "type": "boolean", "description": "是否开启 ssl", "example": true }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 邮箱账号 Response VO" }, "PageResultMailAccountRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/MailAccountRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultListMailAccountSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MailAccountSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MailAccountSimpleRespVO": { "required": [ "id", "mail" ], "type": "object", "properties": { "id": { "type": "integer", "description": "邮箱编号", "format": "int64", "example": 1024 }, "mail": { "type": "string", "description": "邮箱；脱敏展示", "example": "76****8@qq.com" } }, "description": "管理后台 - 邮箱账号的精简 Response VO" }, "CommonResultMailAccountRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/MailAccountRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "LoginLogPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userIp": { "type": "string", "description": "用户 IP，模拟匹配", "example": "127.0.0.1" }, "username": { "type": "string", "description": "用户账号，模拟匹配", "example": "芋道" }, "status": { "type": "boolean", "description": "操作状态", "example": true }, "createTime": { "type": "array", "description": "登录时间", "example": "[2022-07-01 00:00:00,2022-07-01 23:59:59]", "items": { "type": "string", "description": "登录时间", "format": "date-time" } } }, "description": "管理后台 - 登录日志分页列表 Request VO" }, "CommonResultPageResultLoginLogRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultLoginLogRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "LoginLogRespVO": { "required": [ "createTime", "id", "logType", "result", "userIp", "userType", "username" ], "type": "object", "properties": { "id": { "type": "integer", "description": "日志编号", "format": "int64", "example": 1024 }, "logType": { "type": "integer", "description": "日志类型，参见 LoginLogTypeEnum 枚举类", "format": "int32", "example": 1 }, "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 666 }, "userType": { "type": "integer", "description": "用户类型，参见 UserTypeEnum 枚举", "format": "int32", "example": 2 }, "traceId": { "type": "string", "description": "链路追踪编号", "example": "89aca178-a370-411c-ae02-3f0d672be4ab" }, "username": { "type": "string", "description": "用户账号", "example": "todo" }, "result": { "type": "integer", "description": "登录结果，参见 LoginResultEnum 枚举类", "format": "int32", "example": 1 }, "userIp": { "type": "string", "description": "用户 IP", "example": "127.0.0.1" }, "userAgent": { "type": "string", "description": "浏览器 UserAgent", "example": "Mozilla/5.0" }, "origin": { "type": "string", "description": "HTTP Origin 请求头", "example": "https://admin.example.com" }, "countryCode": { "type": "string", "description": "国家编码（ISO 3166-1）", "example": "CN" }, "localCountryName": { "type": "string", "description": "本地国家名称", "example": "中国" }, "ipParseResult": { "type": "string", "description": "IP解析结果详情（JSON格式）", "example": "{\"country\":\"中国\",\"province\":\"广东省\",\"city\":\"深圳市\"}" }, "createTime": { "type": "string", "description": "登录时间", "format": "date-time" } }, "description": "管理后台 - 登录日志 Response VO" }, "PageResultLoginLogRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/LoginLogRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SystemLanguagePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "langCode": { "type": "string", "description": "语言代码，模糊匹配", "example": "zh" }, "langName": { "type": "string", "description": "语言名称，模糊匹配", "example": "中文" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 0 } }, "description": "管理后台 - 系统语言配置分页 Request VO" }, "CommonResultPageResultSystemLanguageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultSystemLanguageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultSystemLanguageRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/SystemLanguageRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "SystemLanguageRespVO": { "required": [ "createTime", "id", "langCode", "langName", "showFlag", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "langCode": { "type": "string", "description": "语言代码", "example": "zh" }, "langName": { "type": "string", "description": "语言名称", "example": "中文（简体）" }, "showFlag": { "type": "boolean", "description": "是否显示", "example": true }, "whitelistUserIds": { "type": "array", "description": "白名单用户ID列表", "example": [ "ALL" ], "items": { "type": "string", "description": "白名单用户ID列表", "example": "[\"ALL\"]" } }, "whitelistCountries": { "type": "array", "description": "白名单国家列表", "example": [ "ALL" ], "items": { "type": "string", "description": "白名单国家列表", "example": "[\"ALL\"]" } }, "sort": { "type": "integer", "description": "排序值", "format": "int32", "example": 0 }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 0 }, "remark": { "type": "string", "description": "备注", "example": "这是一个备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 系统语言配置信息 Response VO" }, "CommonResultSystemLanguageRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/SystemLanguageRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "InformationPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "title": { "type": "string", "description": "标题" }, "topicType": { "type": "integer", "description": "主题类型 ", "format": "int32", "example": 1 }, "language": { "type": "string", "description": "语言" }, "businessType": { "type": "integer", "description": "业务类型 1：公告 2：资讯 ", "format": "int32", "example": 2 }, "terminalType": { "type": "integer", "description": "终端类型 1:PC 2:APP", "format": "int32", "example": 2 }, "status": { "type": "boolean", "description": "状态（0正常 1关闭）", "example": false }, "recommend": { "type": "boolean", "description": "是否推荐阅读（0否 1是）", "example": false }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 平台资讯内容分页 Request VO" }, "CommonResultPageResultInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultInformationRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "InformationRespVO": { "required": [ "businessType", "content", "createTime", "id", "language", "recommend", "status", "summary", "terminalType", "title", "topicType", "updateTime", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 5584 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "5584" }, "title": { "type": "string", "description": "标题" }, "summary": { "type": "string", "description": "摘要" }, "content": { "type": "string", "description": "内容" }, "topicType": { "type": "integer", "description": "主题类型 ", "format": "int32", "example": 1 }, "language": { "type": "string", "description": "语言" }, "coverImg": { "type": "string", "description": "封面图片" }, "businessType": { "type": "integer", "description": "业务类型 1：公告 2：资讯 ", "format": "int32", "example": 2 }, "terminalType": { "type": "integer", "description": "终端类型 1:PC 2:APP", "format": "int32", "example": 2 }, "sort": { "type": "integer", "description": "排序-升序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1关闭）", "format": "int32", "example": 2 }, "recommend": { "type": "boolean", "description": "是否推荐阅读（0否 1是）", "example": false }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "管理后台 - 平台资讯内容 Response VO" }, "PageResultInformationRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/InformationRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/InformationRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListInformationRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InformationRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "GatewayIpBlacklistPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "ip": { "type": "string", "description": "IP / CIDR（模糊匹配）" }, "ipType": { "type": "string", "description": "IP 类型：EXACT / CIDR" }, "source": { "type": "string", "description": "来源：MANUAL / ALERT / JOB" }, "status": { "type": "integer", "description": "状态：0-禁用，1-启用", "format": "int32" }, "permanentOnly": { "type": "boolean", "description": "是否仅查询永久封禁（true：expire_time IS NULL；false / null：不限）" }, "activeOnly": { "type": "boolean", "description": "是否仅查询当前有效（true：未过期且启用；false / null：不限）" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 网关 IP 黑名单分页查询 Request VO" }, "CommonResultPageResultGatewayIpBlacklistRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultGatewayIpBlacklistRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "GatewayIpBlacklistRespVO": { "required": [ "createTime", "id", "ip", "ipType", "source", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64" }, "ip": { "type": "string", "description": "IP / CIDR" }, "ipType": { "type": "string", "description": "IP 类型：EXACT / CIDR" }, "reason": { "type": "string", "description": "封禁原因" }, "expireTime": { "type": "string", "description": "到期时间；NULL 表示永久封禁", "format": "date-time" }, "ttlSeconds": { "type": "integer", "description": "剩余秒数；< 0 表示已过期，NULL 表示永久", "format": "int64" }, "source": { "type": "string", "description": "来源：MANUAL / ALERT / JOB" }, "status": { "type": "integer", "description": "状态：0-禁用，1-启用", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" }, "creator": { "type": "string", "description": "创建者" }, "updater": { "type": "string", "description": "更新者" } }, "description": "管理后台 - 网关 IP 黑名单 Response VO" }, "PageResultGatewayIpBlacklistRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/GatewayIpBlacklistRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultGatewayIpBlacklistRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/GatewayIpBlacklistRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "ErrorCodePageReqVO": { "required": [ "langType", "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "type": { "type": "integer", "description": "错误码类型，参见 ErrorCodeTypeEnum 枚举类", "format": "int32", "example": 1 }, "applicationName": { "type": "string", "description": "应用名", "example": "dashboard" }, "code": { "type": "integer", "description": "错误码编码", "format": "int32", "example": 1234 }, "langType": { "type": "string", "description": "多语言", "example": "zh" }, "message": { "type": "string", "description": "错误码错误提示", "example": "帅气" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 错误码分页 Request VO" }, "CommonResultPageResultErrorCodeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultErrorCodeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "ErrorCodeRespVO": { "required": [ "applicationName", "code", "createTime", "id", "langType", "message", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "错误码编号", "format": "int64", "example": 1024 }, "type": { "type": "integer", "description": "错误码类型，参见 ErrorCodeTypeEnum 枚举类", "format": "int32", "example": 1 }, "applicationName": { "type": "string", "description": "应用名", "example": "dashboard" }, "code": { "type": "integer", "description": "错误码编码", "format": "int32", "example": 1234 }, "langType": { "type": "string", "description": "多语言", "example": "zh" }, "message": { "type": "string", "description": "错误码错误提示", "example": "帅气" }, "memo": { "type": "string", "description": "备注", "example": "哈哈哈" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 错误码 Response VO" }, "PageResultErrorCodeRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/ErrorCodeRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultErrorCodeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/ErrorCodeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictTypePageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "字典类型名称，模糊匹配", "example": "芋道" }, "type": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典类型，模糊匹配", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 字典类型分页列表 Request VO" }, "CommonResultPageResultDictTypeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultDictTypeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictTypeRespVO": { "required": [ "createTime", "id", "name", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "字典类型编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "字典名称", "example": "性别" }, "type": { "type": "string", "description": "字典类型", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 }, "remark": { "type": "string", "description": "备注", "example": "快乐的备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 字典类型信息 Response VO" }, "PageResultDictTypeRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/DictTypeRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultListDictTypeSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DictTypeSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictTypeSimpleRespVO": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "字典类型编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "字典类型名称", "example": "芋道" }, "type": { "type": "string", "description": "字典类型", "example": "sys_common_sex" } }, "description": "管理后台 - 字典类型精简信息 Response VO" }, "CommonResultDictTypeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DictTypeRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictDataPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "label": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典标签", "example": "芋道" }, "dictType": { "maxLength": 100, "minLength": 0, "type": "string", "description": "字典类型，模糊匹配", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "展示状态，参见 CommonStatusEnum 枚举类", "format": "int32", "example": 1 } }, "description": "管理后台 - 字典类型分页列表 Request VO" }, "CommonResultPageResultDictDataRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultDictDataRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictDataRespVO": { "required": [ "createTime", "dictType", "id", "label", "sort", "status", "value" ], "type": "object", "properties": { "id": { "type": "integer", "description": "字典数据编号", "format": "int64", "example": 1024 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "label": { "type": "string", "description": "字典标签", "example": "芋道" }, "value": { "type": "string", "description": "字典值", "example": "iocoder" }, "dictType": { "type": "string", "description": "字典类型", "example": "sys_common_sex" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "colorType": { "type": "string", "description": "颜色类型,default、primary、success、info、warning、danger", "example": "default" }, "cssClass": { "type": "string", "description": "css 样式", "example": "btn-visible" }, "remark": { "type": "string", "description": "备注", "example": "我是一个角色" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 字典数据信息 Response VO" }, "PageResultDictDataRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/DictDataRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultListDictDataSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DictDataSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DictDataSimpleRespVO": { "required": [ "dictType", "label", "value" ], "type": "object", "properties": { "dictType": { "type": "string", "description": "字典类型", "example": "gender" }, "value": { "type": "string", "description": "字典键值", "example": "1" }, "label": { "type": "string", "description": "字典标签", "example": "男" }, "colorType": { "type": "string", "description": "颜色类型，default、primary、success、info、warning、danger", "example": "default" }, "cssClass": { "type": "string", "description": "css 样式", "example": "btn-visible" } }, "description": "管理后台 - 数据字典精简 Response VO" }, "CommonResultDictDataRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DictDataRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListDeptRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeptRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "DeptRespVO": { "required": [ "createTime", "name", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "部门编号", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "部门名称", "example": "芋道" }, "parentId": { "type": "integer", "description": "父部门 ID", "format": "int64", "example": 1024 }, "sort": { "type": "integer", "description": "显示顺序不能为空", "format": "int32", "example": 1024 }, "leaderUserId": { "type": "integer", "description": "负责人的用户编号", "format": "int64", "example": 2048 }, "phone": { "type": "string", "description": "联系电话", "example": "15601691000" }, "email": { "type": "string", "description": "邮箱", "example": "todo@iocoder.cn" }, "status": { "type": "integer", "description": "状态,见 CommonStatusEnum 枚举", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 部门信息 Response VO" }, "CommonResultListDeptSimpleRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeptSimpleRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultDeptRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/DeptRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CurrencyRatePolicyPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "policyType": { "type": "integer", "description": "策略类型：1-按国家 2-按客户", "format": "int32" }, "countryCode": { "type": "string", "description": "国家编码" }, "userId": { "type": "integer", "description": "用户ID", "format": "int64" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 汇率策略配置分页 Request VO" }, "CommonResultPageResultCurrencyRatePolicyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultCurrencyRatePolicyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CurrencyRatePolicyRespVO": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64" }, "policyType": { "type": "integer", "description": "策略类型：1-按国家 2-按客户", "format": "int32" }, "countryCode": { "type": "string", "description": "国家编码" }, "userId": { "type": "integer", "description": "用户ID", "format": "int64" }, "premiumRate": { "type": "number", "description": "溢价比例(%)" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "remark": { "type": "string", "description": "备注说明" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "管理后台 - 汇率策略配置 Response VO" }, "PageResultCurrencyRatePolicyRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/CurrencyRatePolicyRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultCurrencyRatePolicyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/CurrencyRatePolicyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonClassifyListReqVO": { "type": "object", "properties": { "className": { "type": "string", "description": "分类名称", "example": "王五" }, "positionType": { "type": "integer", "description": "定位类型 1：帮助中心 2资讯中心", "format": "int32", "example": 1 }, "isHot": { "type": "boolean", "description": "热门分类 0否 1是" }, "language": { "type": "string", "description": "语言" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 平台分类管理列表 Request VO" }, "CommonClassifyRespVO": { "required": [ "children", "className", "createTime", "disabled", "id", "language", "parentId", "parentUuid", "positionType", "sort", "status", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 17162 }, "uuidCode": { "type": "string", "description": "uuidcode", "example": "17162" }, "className": { "type": "string", "description": "分类名称", "example": "王五" }, "parentId": { "type": "integer", "description": "父Id(当前表）", "format": "int64", "example": 16881 }, "parentUuid": { "type": "string", "description": "父uuid(当前表）", "example": "16881" }, "positionType": { "type": "integer", "description": "定位类型 1：帮助中心 ", "format": "int32", "example": 1 }, "isHot": { "type": "boolean", "description": "热门分类 0否 1是" }, "language": { "type": "string", "description": "语言" }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "disabled": { "type": "boolean", "description": "禁用" }, "children": { "type": "array", "description": "子分类", "items": { "$ref": "#/components/schemas/CommonClassifyRespVO" } } }, "description": "管理后台 - 平台分类管理 Response VO" }, "CommonResultListCommonClassifyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommonClassifyRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultCommonClassifyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/CommonClassifyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BasicRegionPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "名称", "example": "赵六" }, "province": { "type": "integer", "description": "类型", "format": "int32" }, "regionCode": { "type": "string", "description": "行政区代码" }, "countryId": { "type": "integer", "description": "所属国家", "format": "int64", "example": 528 }, "postalCode": { "type": "string", "description": "邮编" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 行政地区管理分页 Request VO" }, "BasicRegionRespVO": { "required": [ "countryId", "createTime", "id", "name", "province", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 2942 }, "name": { "type": "string", "description": "名称", "example": "赵六" }, "province": { "type": "integer", "description": "类型", "format": "int32" }, "regionCode": { "type": "string", "description": "行政区代码" }, "countryId": { "type": "integer", "description": "所属国家", "format": "int64", "example": 528 }, "postalCode": { "type": "string", "description": "邮编" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示次序", "format": "int64" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 行政地区管理 Response VO" }, "CommonResultPageResultBasicRegionRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultBasicRegionRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultBasicRegionRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/BasicRegionRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "BasicRegionIsoAlphaItemRespVO": { "type": "object", "properties": { "regionCode": { "type": "string", "description": "ISO 3166-2 行政区代码", "example": "US-CA" }, "name": { "type": "string", "description": "州/省名称", "example": "California" }, "type": { "type": "string", "description": "类型", "example": "State" } }, "description": "管理后台 - ISO3166-2 州/省标准项" }, "BasicRegionIsoAlphaRespVO": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "国家简码（ISO 3166-1 alpha-2）", "example": "MY" }, "subdivisions": { "type": "array", "description": "州/省标准列表", "items": { "$ref": "#/components/schemas/BasicRegionIsoAlphaItemRespVO" } } }, "description": "管理后台 - ISO3166-2 alpha 代理响应" }, "CommonResultBasicRegionIsoAlphaRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BasicRegionIsoAlphaRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultBasicRegionRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BasicRegionRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BasicCurrencyPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "名称" }, "abbreviationCode": { "type": "string", "description": "国际缩写" }, "exchangeRate": { "type": "number", "description": "汇率" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "sort": { "type": "integer", "description": "排序 1-999 数字升序", "format": "int32" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 系统-基础数据-币种分页 Request VO" }, "BasicCurrencyRespVO": { "required": [ "abbreviationCode", "exchangeRate", "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64" }, "name": { "type": "string", "description": "名称" }, "abbreviationCode": { "type": "string", "description": "国际缩写" }, "exchangeRate": { "type": "number", "description": "汇率" }, "realTimeExchangeRate": { "type": "number", "description": "实时汇率" }, "icon": { "type": "string", "description": "图标" }, "symbol": { "type": "string", "description": "符号" }, "status": { "type": "integer", "description": "是否启用 1启用 0禁用", "format": "int32" }, "sort": { "type": "integer", "description": "排序 1-999 数字升序", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "管理后台 - 币种 Response VO" }, "CommonResultPageResultBasicCurrencyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultBasicCurrencyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultBasicCurrencyRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/BasicCurrencyRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultBasicCurrencyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BasicCurrencyRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListBasicCurrencyRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicCurrencyRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BasicCountryPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "enName": { "type": "string", "description": "名称(英文)", "example": "王五" }, "localName": { "type": "string", "description": "名称(本地)", "example": "赵六" }, "enShortName": { "type": "string", "description": "简称(英文)", "example": "李四" }, "currencyId": { "type": "integer", "description": "默认币种（对应币种id）", "format": "int64", "example": 31635 }, "areaId": { "type": "integer", "description": "默认区域 对应area表id", "format": "int32", "example": 18455 }, "icon": { "type": "string", "description": "图标" }, "isHot": { "type": "boolean", "description": "是否热门国家 0否 1是" }, "globalCode": { "type": "string", "description": "国际区号" }, "postalCode": { "type": "string", "description": "邮编" }, "letterGroup": { "type": "string", "description": "首字母分组 ABC/BCD" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 国家信息分页 Request VO" }, "BasicCountryRespVO": { "required": [ "areaId", "createTime", "enName", "enShortName", "id", "localName", "sort", "status" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 296 }, "enName": { "type": "string", "description": "名称(英文)", "example": "王五" }, "localName": { "type": "string", "description": "名称(本地)", "example": "赵六" }, "enShortName": { "type": "string", "description": "简称(英文)", "example": "李四" }, "currencyId": { "type": "integer", "description": "默认币种（对应币种id）", "format": "int64", "example": 31635 }, "areaId": { "type": "integer", "description": "默认区域 对应area表id", "format": "int32", "example": 18455 }, "icon": { "type": "string", "description": "图标" }, "isHot": { "type": "boolean", "description": "是否热门国家 0否 1是" }, "globalCode": { "type": "string", "description": "国际区号" }, "postalCode": { "type": "string", "description": "邮编" }, "letterGroup": { "type": "string", "description": "首字母分组 ABC/BCD" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "显示次序", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - 国家信息 Response VO" }, "CommonResultPageResultBasicCountryRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultBasicCountryRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultBasicCountryRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/BasicCountryRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultBasicCountryRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BasicCountryRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BasicAreaPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "enName": { "type": "string", "description": "名称(英文)", "example": "李四" }, "localName": { "type": "string", "description": "名称(本地)", "example": "李四" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 区域管理分页 Request VO" }, "BasicAreaRespVO": { "required": [ "createTime", "enName", "id", "localName", "sort", "status", "updateTime" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64", "example": 25796 }, "enName": { "type": "string", "description": "名称(英文)", "example": "李四" }, "localName": { "type": "string", "description": "名称(本地)", "example": "李四" }, "icon": { "type": "string", "description": "图标" }, "sort": { "type": "integer", "description": "显示次序", "format": "int64" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 1 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "修改时间", "format": "date-time" } }, "description": "管理后台 - 区域管理 Response VO" }, "CommonResultPageResultBasicAreaRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultBasicAreaRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultBasicAreaRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/BasicAreaRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultBasicAreaRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BasicAreaRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListBasicAreaRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicAreaRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "BannerPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "name": { "type": "string", "description": "banner名称", "example": "王五" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "targetLink": { "type": "string", "description": "跳转链接" }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型 1:PC 2:APP", "format": "int32", "example": 1 }, "redirectType": { "type": "integer", "description": "跳转类型", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 2 }, "sceneType": { "type": "string", "description": "页面场景类型", "example": "HOME" }, "displayStrategy": { "type": "string", "description": "展示策略", "example": "ALL" }, "themeMode": { "type": "string", "description": "主题模式", "example": "ALL" }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - banner分页 Request VO" }, "BannerRespVO": { "required": [ "createTime", "id", "imgUrl", "language", "name", "redirectType", "sceneType", "sort", "status", "terminalType" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键ID", "format": "int64", "example": 9461 }, "name": { "type": "string", "description": "banner名称", "example": "王五" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "targetLink": { "type": "string", "description": "跳转链接" }, "redirectType": { "type": "integer", "description": "跳转类型", "format": "int32", "example": 1 }, "language": { "type": "string", "description": "语言" }, "terminalType": { "type": "integer", "description": "终端类型", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "状态（0正常 1停用）", "format": "int32", "example": 2 }, "sceneType": { "type": "string", "description": "页面场景类型", "example": "HOME" }, "displayStrategy": { "type": "string", "description": "展示策略（ALL=全部用户 NEW=新用户 OLD=老客户）", "example": "ALL" }, "themeMode": { "type": "string", "description": "主题模式（ALL=不限 LIGHT=仅明亮模式 DARK=仅暗黑模式）", "example": "ALL" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - banner Response VO" }, "CommonResultPageResultBannerRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultBannerRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultBannerRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/BannerRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultBannerRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/BannerRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AuthTurnstileConfigRespVO": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "当前请求是否应展示/校验 Turnstile（与历史 enabled 语义一致）" }, "siteKey": { "type": "string", "description": "站点密钥（enabled 为 true 时返回，供前端渲染组件）" }, "loginIp": { "type": "string", "description": "当前请求的客户端登录 IP（已 trim）" }, "ipLocation": { "$ref": "#/components/schemas/IpLocationInfoRespDTO" } }, "description": "管理后台 - Turnstile 人机验证配置" }, "CommonResultAuthTurnstileConfigRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AuthTurnstileConfigRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "IpLocationInfoRespDTO": { "type": "object", "properties": { "countryCode": { "type": "string", "description": "国家编码（ISO 3166-1）", "example": "CN" }, "localCountryName": { "type": "string", "description": "本地国家名称", "example": "中国" }, "ipParseResult": { "type": "string", "description": "IP解析结果详情（JSON格式）", "example": "{\"country\":\"中国\",\"province\":\"广东省\",\"city\":\"深圳市\"}" } }, "description": "RPC 服务 - IP 位置信息 Response DTO" }, "AuthPermissionInfoRespVO": { "required": [ "menus", "permissions", "roles", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserVO" }, "roles": { "uniqueItems": true, "type": "array", "description": "角色标识数组", "items": { "type": "string", "description": "角色标识数组" } }, "permissions": { "uniqueItems": true, "type": "array", "description": "操作权限数组", "items": { "type": "string", "description": "操作权限数组" } }, "menus": { "type": "array", "description": "菜单树", "items": { "$ref": "#/components/schemas/MenuVO" } } }, "description": "管理后台 - 登录用户的权限信息 Response VO，额外包括用户信息和角色列表" }, "CommonResultAuthPermissionInfoRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AuthPermissionInfoRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "MenuVO": { "required": [ "id", "keepAlive", "name", "parentId", "visible" ], "type": "object", "properties": { "id": { "type": "integer", "description": "菜单名称", "format": "int64" }, "parentId": { "type": "integer", "description": "父菜单 ID", "format": "int64", "example": 1024 }, "name": { "type": "string", "description": "菜单名称", "example": "芋道" }, "path": { "type": "string", "description": "路由地址,仅菜单类型为菜单或者目录时，才需要传", "example": "post" }, "component": { "type": "string", "description": "组件路径,仅菜单类型为菜单时，才需要传", "example": "system/post/index" }, "componentName": { "type": "string", "description": "组件名", "example": "SystemUser" }, "icon": { "type": "string", "description": "菜单图标,仅菜单类型为菜单或者目录时，才需要传", "example": "/menu/list" }, "visible": { "type": "boolean", "description": "是否可见", "example": false }, "keepAlive": { "type": "boolean", "description": "是否缓存", "example": false }, "alwaysShow": { "type": "boolean", "description": "是否总是显示", "example": false }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/MenuVO" } } }, "description": "管理后台 - 登录用户的菜单信息 Response VO" }, "UserVO": { "required": [ "avatar", "id", "nickname" ], "type": "object", "properties": { "id": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "nickname": { "type": "string", "description": "用户昵称", "example": "芋道源码" }, "avatar": { "type": "string", "description": "用户头像", "example": "https://www.iocoder.cn/xx.jpg" } }, "description": "用户信息 VO" }, "AreaNodeRespVO": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int32", "example": 110000 }, "name": { "type": "string", "description": "名字", "example": "北京" } }, "description": "管理后台 - 地区节点 Response VO" }, "CommonResultListAreaNodeRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AreaNodeRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppVersionPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "os": { "type": "string", "description": "操作系统", "example": "ANDROID" }, "status": { "type": "integer", "description": "状态", "format": "int32", "example": 0 }, "versionCode": { "type": "string", "description": "版本号，模糊匹配", "example": "2.1" } }, "description": "管理后台 - App版本分页 Request VO" }, "AppVersionRespVO": { "required": [ "createTime", "downloadUrl", "id", "os", "status", "updateType", "versionCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "os": { "type": "string", "description": "操作系统", "example": "ANDROID" }, "versionCode": { "type": "string", "description": "版本号", "example": "2.1.0" }, "versionNum": { "type": "integer", "description": "版本数字序号", "format": "int32", "example": 20100 }, "updateType": { "type": "integer", "description": "更新类型: 1-强制更新 2-可选更新", "format": "int32", "example": 2 }, "status": { "type": "integer", "description": "状态: 0-草稿 1-已发布 2-已下架", "format": "int32", "example": 0 }, "downloadUrl": { "type": "string", "description": "下载地址" }, "updateContent": { "type": "string", "description": "更新日志(JSON 多语言)" }, "minSupportVersion": { "type": "string", "description": "最低支持版本号" }, "publishTime": { "type": "string", "description": "发布时间", "format": "date-time" }, "remark": { "type": "string", "description": "备注" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - App版本信息 Response VO" }, "CommonResultPageResultAppVersionRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultAppVersionRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultAppVersionRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/AppVersionRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultAppVersionRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AppVersionRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AppVersionGrayRespVO": { "required": [ "createTime", "grayType", "grayValue", "id", "status", "versionId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "编号", "format": "int64", "example": 1024 }, "versionId": { "type": "integer", "description": "关联版本ID", "format": "int64" }, "grayType": { "type": "integer", "description": "灰度类型: 1-按用户ID 2-按比例 3-按地区", "format": "int32" }, "grayValue": { "type": "string", "description": "灰度值(JSON)" }, "status": { "type": "integer", "description": "状态: 0-禁用 1-启用", "format": "int32" }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" } }, "description": "管理后台 - App版本灰度规则 Response VO" }, "CommonResultListAppVersionGrayRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppVersionGrayRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "AdvertPageReqVO": { "required": [ "pageNo", "pageSize" ], "type": "object", "properties": { "pageNo": { "minimum": 1, "type": "integer", "description": "页码，从 1 开始", "format": "int32", "example": 1 }, "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "description": "每页条数，最大值为 100", "format": "int32", "example": 10 }, "title": { "type": "string", "description": "标题" }, "sketchText": { "type": "string", "description": "简述文案" }, "language": { "type": "string", "description": "语种" }, "terminalType": { "type": "integer", "description": "终端类型1:PC 2:APP", "format": "int32", "example": 1 }, "status": { "type": "integer", "description": "帐号状态（0正常 1停用）", "format": "int32", "example": 2 }, "createTime": { "type": "array", "description": "创建时间", "items": { "type": "string", "description": "创建时间", "format": "date-time" } } }, "description": "管理后台 - 广告栏位分页 Request VO" }, "AdvertRespVO": { "required": [ "createTime", "id", "imgUrl", "language", "sort", "status", "terminalType", "title", "updateTime", "uuidCode" ], "type": "object", "properties": { "id": { "type": "integer", "description": "主键id", "format": "int64", "example": 19495 }, "uuidCode": { "type": "string", "description": "uuidCode", "example": "19495" }, "title": { "type": "string", "description": "标题" }, "sketchText": { "type": "string", "description": "简述文案" }, "imgUrl": { "type": "string", "description": "图片链接", "example": "https://www.iocoder.cn" }, "targetLink": { "type": "string", "description": "跳转链接" }, "buttonCnfig": { "type": "string", "description": "按钮配置json字段" }, "language": { "type": "string", "description": "语种" }, "terminalType": { "type": "integer", "description": "终端类型1:PC 2:APP", "format": "int32", "example": 1 }, "sort": { "type": "integer", "description": "排序", "format": "int32" }, "status": { "type": "integer", "description": "帐号状态（0正常 1停用）", "format": "int32", "example": 2 }, "createTime": { "type": "string", "description": "创建时间", "format": "date-time" }, "updateTime": { "type": "string", "description": "更新时间", "format": "date-time" } }, "description": "管理后台 - 广告栏位 Response VO" }, "CommonResultPageResultAdvertRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/PageResultAdvertRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "PageResultAdvertRespVO": { "required": [ "list", "total" ], "type": "object", "properties": { "list": { "type": "array", "description": "数据", "items": { "$ref": "#/components/schemas/AdvertRespVO" } }, "total": { "type": "integer", "description": "总量", "format": "int64" } }, "description": "分页结果" }, "CommonResultAdvertRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/AdvertRespVO" }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "CommonResultListAdvertRespVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvertRespVO" } }, "msg": { "type": "string" }, "error_detail": { "type": "string" } } }, "SocialUserUnbindReqDTO": { "required": [ "openid", "socialType", "userId", "userType" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "用户编号", "format": "int64", "example": 1024 }, "userType": { "type": "integer", "description": "用户类型", "format": "int32", "example": 1 }, "socialType": { "type": "integer", "description": "社交平台的类型", "format": "int32", "example": 1 }, "openid": { "type": "string", "description": "社交平台的 openid", "example": "zsw" } }, "description": "RPC 服务 - 取消绑定社交用户 Request DTO" }, "SocialUserUnbindReqVO": { "required": [ "openid", "type" ], "type": "object", "properties": { "type": { "type": "integer", "description": "社交平台的类型，参见 UserSocialTypeEnum 枚举值", "format": "int32", "example": 10 }, "openid": { "type": "string", "description": "社交用户的 openid", "example": "IPRmJ0wvBptiPIlGEZiPewGwiEiE" } }, "description": "管理后台 - 取消社交绑定 Request VO" } }, "securitySchemes": { "Authorization": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "x-openapi": { "x-setting": { "customCode": 200, "language": "zh-CN", "enableSwaggerModels": true, "swaggerModelName": "Swagger Models", "enableReloadCacheParameter": false, "enableAfterScript": true, "enableDocumentManage": true, "enableVersion": false, "enableRequestCache": true, "enableFilterMultipartApis": false, "enableFilterMultipartApiMethodType": "POST", "enableHost": false, "enableHostText": "", "enableDynamicParameter": false, "enableDebug": true, "enableFooter": true, "enableFooterCustom": false, "enableSearch": true, "enableOpenApi": true, "enableHomeCustom": false, "enableGroup": true, "enableResponseCode": true }, "x-markdownFiles": [] } }