Files
rlz/API文档.txt

1177 lines
28 KiB
Plaintext
Raw Normal View History

2026-01-26 15:02:59 +08:00
========================================
瑞来兹医助管理系统 - API接口文档
========================================
一、基本信息
-----------
项目名称:瑞来兹医助管理系统
API版本3.8.3
基础路径http://localhost:8039
请求前缀:/dev-apiSwagger配置
认证方式JWT TokenHeader: Authorization
文档生成时间2024年
二、通用说明
-----------
1. 请求格式JSON
2. 响应格式JSON
3. 认证Token在请求头中添加 Authorization: Bearer {token}
4. 分页参数pageNum页码、pageSize每页数量
5. 统一响应格式:
{
"code": 200, // 状态码200表示成功
"msg": "操作成功", // 提示信息
"data": {} // 返回数据
}
三、API接口列表
-----------
【1. 登录认证模块】
1.1 获取验证码
URL: GET /captchaImage
说明: 获取登录验证码图片
参数: 无
返回: {
"uuid": "验证码唯一标识",
"img": "Base64编码的图片",
"captchaOnOff": true/false
}
1.2 用户登录
URL: POST /login
说明: 系统用户登录
参数: {
"username": "用户名",
"password": "密码",
"code": "验证码",
"uuid": "验证码UUID"
}
返回: {
"token": "JWT令牌"
}
1.3 APP登录
URL: POST /appLogin
说明: 移动端APP登录
参数: {
"username": "用户名",
"password": "密码"
}
返回: {
"userId": "用户ID",
"userName": "用户名",
"nickName": "昵称",
"phonenumber": "手机号",
"headimage": "头像URL",
"leijijine": "累计收益",
"yue": "余额",
"token": "JWT令牌"
}
1.4 短信登录
URL: POST /smsLogin
说明: 通过手机验证码登录
参数: {
"phoneNumber": "手机号",
"code": "验证码"
}
返回: {
"userId": "用户ID",
"userName": "用户名",
"nickName": "昵称",
"phonenumber": "手机号",
"headimage": "头像URL",
"leijijine": "累计收益",
"yue": "余额",
"token": "JWT令牌"
}
1.5 微信登录
URL: POST /weixinLogin
说明: 微信小程序登录
参数: {
"wxcode": "微信code",
"encryptedData": "加密数据",
"iv": "初始向量"
}
返回: {
"userId": "用户ID",
"token": "JWT令牌",
"phoneNumber": "手机号"
}
1.6 获取用户信息
URL: GET /getInfo
说明: 获取当前登录用户信息
认证: 需要Token
返回: {
"user": "用户信息",
"roles": ["角色列表"],
"permissions": ["权限列表"]
}
1.7 获取路由信息
URL: GET /getRouters
说明: 获取用户菜单路由
认证: 需要Token
返回: 菜单路由树结构
1.8 获取用户Token
URL: GET /getUserToken
说明: 根据用户信息获取Token
参数: {
"phonenumber": "手机号"
}
返回: {
"token": "JWT令牌",
"userId": "用户ID"
}
1.9 用户注册
URL: POST /register
说明: 新用户注册
参数: {
"username": "用户名",
"password": "密码",
"phonenumber": "手机号",
...
}
返回: 注册结果
【2. 用户管理模块】
2.1 获取用户列表
URL: GET /system/user/list
说明: 分页查询用户列表
认证: 需要Token
参数: {
"userName": "用户名(可选)",
"phonenumber": "手机号(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页用户列表
2.2 导出用户数据
URL: POST /system/user/export
说明: 导出用户数据为Excel
认证: 需要Token
参数: {
"userName": "用户名(可选)",
...
}
返回: Excel文件流
2.3 导入用户数据
URL: POST /system/user/importData
说明: 从Excel导入用户数据
认证: 需要Token
参数: {
"file": "Excel文件",
"updateSupport": true/false
}
返回: 导入结果
2.4 下载导入模板
URL: POST /system/user/importTemplate
说明: 下载用户导入模板
认证: 需要Token
返回: Excel模板文件
2.5 获取用户详情
URL: GET /system/user/{userId}
说明: 根据用户ID获取用户详细信息
认证: 需要Token
参数: userId路径参数
返回: 用户详细信息
2.6 新增用户
URL: POST /system/user
说明: 新增用户
认证: 需要Token
参数: {
"userName": "用户名",
"nickName": "昵称",
"email": "邮箱",
"phonenumber": "手机号",
"sex": "性别",
"password": "密码",
"deptId": "部门ID",
"postIds": [岗位ID数组],
"roleIds": [角色ID数组]
}
返回: 操作结果
2.7 修改用户
URL: PUT /system/user
说明: 修改用户信息
认证: 需要Token
参数: {
"userId": "用户ID",
"userName": "用户名",
...
}
返回: 操作结果
2.8 完善用户信息
URL: POST /system/user/perfectUserInfo
说明: 完善用户详细信息
认证: 需要Token
参数: 用户信息对象
返回: 操作结果
2.9 删除用户
URL: DELETE /system/user/{userIds}
说明: 批量删除用户
认证: 需要Token
参数: userIds路径参数多个用逗号分隔
返回: 操作结果
2.10 重置密码
URL: PUT /system/user/resetPwd
说明: 重置用户密码
认证: 需要Token
参数: {
"userId": "用户ID",
"password": "新密码"
}
返回: 操作结果
2.11 注销用户
URL: POST /system/user/zhuxiao
说明: 注销用户账号
认证: 需要Token
参数: {
"userId": "用户ID"
}
返回: 操作结果
2.12 修改用户状态
URL: PUT /system/user/changeStatus
说明: 修改用户启用/禁用状态
认证: 需要Token
参数: {
"userId": "用户ID",
"status": "0正常/1停用"
}
返回: 操作结果
2.13 分配角色
URL: GET /system/user/authRole/{userId}
说明: 获取用户角色分配信息
认证: 需要Token
参数: userId路径参数
返回: 角色分配信息
2.14 保存角色分配
URL: PUT /system/user/authRole
说明: 保存用户角色分配
认证: 需要Token
参数: {
"userId": "用户ID",
"roleIds": [角色ID数组]
}
返回: 操作结果
2.15 获取认证Token
URL: GET /system/user/getAuthToken
说明: 获取用户认证Token
认证: 需要Token
返回: Token信息
2.16 获取APP用户信息
URL: GET /system/user/getAppUserInfo
说明: 获取移动端用户信息
认证: 需要Token
返回: 用户详细信息
2.17 获取APP首页信息
URL: GET /system/user/getAppIndexInfo
说明: 获取移动端首页数据
认证: 需要Token
返回: 首页数据
【3. 角色管理模块】
3.1 获取角色列表
URL: GET /system/role/list
说明: 分页查询角色列表
认证: 需要Token
参数: {
"roleName": "角色名称(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页角色列表
3.2 导出角色数据
URL: POST /system/role/export
说明: 导出角色数据为Excel
认证: 需要Token
返回: Excel文件流
3.3 获取角色详情
URL: GET /system/role/{roleId}
说明: 根据角色ID获取详细信息
认证: 需要Token
参数: roleId路径参数
返回: 角色详细信息
3.4 新增角色
URL: POST /system/role
说明: 新增角色
认证: 需要Token
参数: {
"roleName": "角色名称",
"roleKey": "角色权限",
"roleSort": "显示顺序",
"status": "状态",
"menuIds": [菜单ID数组],
"remark": "备注"
}
返回: 操作结果
3.5 修改角色
URL: PUT /system/role
说明: 修改角色信息
认证: 需要Token
参数: 角色信息对象
返回: 操作结果
3.6 数据权限分配
URL: PUT /system/role/dataScope
说明: 分配角色数据权限
认证: 需要Token
参数: {
"roleId": "角色ID",
"dataScope": "数据范围",
"deptIds": [部门ID数组]
}
返回: 操作结果
3.7 修改角色状态
URL: PUT /system/role/changeStatus
说明: 修改角色启用/禁用状态
认证: 需要Token
参数: {
"roleId": "角色ID",
"status": "0正常/1停用"
}
返回: 操作结果
3.8 删除角色
URL: DELETE /system/role/{roleIds}
说明: 批量删除角色
认证: 需要Token
参数: roleIds路径参数多个用逗号分隔
返回: 操作结果
3.9 获取角色选项
URL: GET /system/role/optionselect
说明: 获取角色下拉选项
认证: 需要Token
返回: 角色选项列表
3.10 查询已分配用户
URL: GET /system/role/authUser/allocatedList
说明: 查询已分配角色的用户列表
认证: 需要Token
参数: {
"roleId": "角色ID",
"userName": "用户名(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 用户列表
3.11 查询未分配用户
URL: GET /system/role/authUser/unallocatedList
说明: 查询未分配角色的用户列表
认证: 需要Token
参数: {
"roleId": "角色ID",
"userName": "用户名(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 用户列表
3.12 取消用户授权
URL: PUT /system/role/authUser/cancel
说明: 取消用户角色授权
认证: 需要Token
参数: {
"roleId": "角色ID",
"userId": "用户ID"
}
返回: 操作结果
3.13 批量取消授权
URL: PUT /system/role/authUser/cancelAll
说明: 批量取消用户角色授权
认证: 需要Token
参数: {
"roleId": "角色ID",
"userIds": "用户ID字符串逗号分隔"
}
返回: 操作结果
3.14 批量选择授权
URL: PUT /system/role/authUser/selectAll
说明: 批量选择用户授权
认证: 需要Token
参数: {
"roleId": "角色ID",
"userIds": "用户ID字符串逗号分隔"
}
返回: 操作结果
【4. 菜单管理模块】
4.1 获取菜单列表
URL: GET /system/menu/list
说明: 获取菜单列表
认证: 需要Token
参数: {
"menuName": "菜单名称(可选)",
"status": "状态(可选)"
}
返回: 菜单列表
4.2 获取菜单详情
URL: GET /system/menu/{menuId}
说明: 根据菜单ID获取详细信息
认证: 需要Token
参数: menuId路径参数
返回: 菜单详细信息
4.3 获取菜单树
URL: GET /system/menu/treeselect
说明: 获取菜单下拉树列表
认证: 需要Token
返回: 菜单树结构
4.4 获取角色菜单树
URL: GET /system/menu/roleMenuTreeselect/{roleId}
说明: 加载对应角色菜单列表树
认证: 需要Token
参数: roleId路径参数
返回: {
"menus": "菜单树",
"checkedKeys": [已选中的菜单ID数组]
}
4.5 新增菜单
URL: POST /system/menu
说明: 新增菜单
认证: 需要Token
参数: {
"menuName": "菜单名称",
"parentId": "父菜单ID",
"orderNum": "显示顺序",
"path": "路由地址",
"component": "组件路径",
"menuType": "菜单类型",
"visible": "是否显示",
"perms": "权限标识",
"icon": "菜单图标",
...
}
返回: 操作结果
4.6 修改菜单
URL: PUT /system/menu
说明: 修改菜单信息
认证: 需要Token
参数: 菜单信息对象
返回: 操作结果
4.7 删除菜单
URL: DELETE /system/menu/{menuId}
说明: 删除菜单
认证: 需要Token
参数: menuId路径参数
返回: 操作结果
【5. 部门管理模块】
5.1 获取部门列表
URL: GET /system/dept/list
说明: 获取部门列表
认证: 需要Token
参数: {
"deptName": "部门名称(可选)",
"status": "状态(可选)"
}
返回: 部门列表
5.2 排除指定部门
URL: GET /system/dept/list/exclude/{deptId}
说明: 获取部门列表(排除指定部门)
认证: 需要Token
参数: deptId路径参数
返回: 部门列表
5.3 获取部门详情
URL: GET /system/dept/{deptId}
说明: 根据部门ID获取详细信息
认证: 需要Token
参数: deptId路径参数
返回: 部门详细信息
5.4 获取部门树
URL: GET /system/dept/treeselect
说明: 获取部门下拉树列表
认证: 需要Token
返回: 部门树结构
5.5 获取角色部门树
URL: GET /system/dept/roleDeptTreeselect/{roleId}
说明: 加载对应角色部门列表树
认证: 需要Token
参数: roleId路径参数
返回: {
"depts": "部门树",
"checkedKeys": [已选中的部门ID数组]
}
5.6 新增部门
URL: POST /system/dept
说明: 新增部门
认证: 需要Token
参数: {
"parentId": "父部门ID",
"deptName": "部门名称",
"orderNum": "显示顺序",
"leader": "负责人",
"phone": "联系电话",
"email": "邮箱",
"status": "状态"
}
返回: 操作结果
5.7 修改部门
URL: PUT /system/dept
说明: 修改部门信息
认证: 需要Token
参数: 部门信息对象
返回: 操作结果
5.8 删除部门
URL: DELETE /system/dept/{deptId}
说明: 删除部门
认证: 需要Token
参数: deptId路径参数
返回: 操作结果
【6. 岗位管理模块】
6.1 获取岗位列表
URL: GET /system/post/list
说明: 分页查询岗位列表
认证: 需要Token
参数: {
"postName": "岗位名称(可选)",
"postCode": "岗位编码(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页岗位列表
6.2 导出岗位数据
URL: POST /system/post/export
说明: 导出岗位数据为Excel
认证: 需要Token
返回: Excel文件流
6.3 获取岗位详情
URL: GET /system/post/{postId}
说明: 根据岗位ID获取详细信息
认证: 需要Token
参数: postId路径参数
返回: 岗位详细信息
6.4 新增岗位
URL: POST /system/post
说明: 新增岗位
认证: 需要Token
参数: {
"postCode": "岗位编码",
"postName": "岗位名称",
"postSort": "显示顺序",
"status": "状态",
"remark": "备注"
}
返回: 操作结果
6.5 修改岗位
URL: PUT /system/post
说明: 修改岗位信息
认证: 需要Token
参数: 岗位信息对象
返回: 操作结果
6.6 删除岗位
URL: DELETE /system/post/{postIds}
说明: 批量删除岗位
认证: 需要Token
参数: postIds路径参数多个用逗号分隔
返回: 操作结果
6.7 获取岗位选项
URL: GET /system/post/optionselect
说明: 获取岗位下拉选项
认证: 需要Token
返回: 岗位选项列表
【7. 字典管理模块】
7.1 字典类型列表
URL: GET /system/dict/type/list
说明: 分页查询字典类型列表
认证: 需要Token
参数: {
"dictName": "字典名称(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页字典类型列表
7.2 导出字典类型
URL: POST /system/dict/type/export
说明: 导出字典类型数据
认证: 需要Token
返回: Excel文件流
7.3 获取字典类型详情
URL: GET /system/dict/type/{dictId}
说明: 根据字典类型ID获取详细信息
认证: 需要Token
参数: dictId路径参数
返回: 字典类型详细信息
7.4 新增字典类型
URL: POST /system/dict/type
说明: 新增字典类型
认证: 需要Token
参数: {
"dictName": "字典名称",
"dictType": "字典类型",
"status": "状态",
"remark": "备注"
}
返回: 操作结果
7.5 修改字典类型
URL: PUT /system/dict/type
说明: 修改字典类型
认证: 需要Token
参数: 字典类型信息对象
返回: 操作结果
7.6 删除字典类型
URL: DELETE /system/dict/type/{dictIds}
说明: 批量删除字典类型
认证: 需要Token
参数: dictIds路径参数多个用逗号分隔
返回: 操作结果
7.7 刷新字典缓存
URL: DELETE /system/dict/type/refreshCache
说明: 刷新字典缓存
认证: 需要Token
返回: 操作结果
7.8 获取字典类型选项
URL: GET /system/dict/type/optionselect
说明: 获取字典类型下拉选项
认证: 需要Token
返回: 字典类型选项列表
7.9 字典数据列表
URL: GET /system/dict/data/list
说明: 分页查询字典数据列表
认证: 需要Token
参数: {
"dictType": "字典类型(可选)",
"dictLabel": "字典标签(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页字典数据列表
7.10 导出字典数据
URL: POST /system/dict/data/export
说明: 导出字典数据
认证: 需要Token
返回: Excel文件流
7.11 获取字典数据详情
URL: GET /system/dict/data/{dictCode}
说明: 根据字典数据编码获取详细信息
认证: 需要Token
参数: dictCode路径参数
返回: 字典数据详细信息
7.12 根据字典类型获取数据
URL: GET /system/dict/data/type/{dictType}
说明: 根据字典类型获取字典数据
认证: 需要Token
参数: dictType路径参数
返回: 字典数据列表
7.13 新增字典数据
URL: POST /system/dict/data
说明: 新增字典数据
认证: 需要Token
参数: {
"dictSort": "字典排序",
"dictLabel": "字典标签",
"dictValue": "字典键值",
"dictType": "字典类型",
"cssClass": "样式属性",
"listClass": "表格回显样式",
"isDefault": "是否默认",
"status": "状态",
"remark": "备注"
}
返回: 操作结果
7.14 修改字典数据
URL: PUT /system/dict/data
说明: 修改字典数据
认证: 需要Token
参数: 字典数据信息对象
返回: 操作结果
7.15 删除字典数据
URL: DELETE /system/dict/data/{dictCodes}
说明: 批量删除字典数据
认证: 需要Token
参数: dictCodes路径参数多个用逗号分隔
返回: 操作结果
【8. 参数配置模块】
8.1 获取参数列表
URL: GET /system/config/list
说明: 分页查询参数配置列表
认证: 需要Token
参数: {
"configName": "参数名称(可选)",
"configKey": "参数键名(可选)",
"configType": "系统内置(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页参数列表
8.2 导出参数配置
URL: POST /system/config/export
说明: 导出参数配置数据
认证: 需要Token
返回: Excel文件流
8.3 获取参数详情
URL: GET /system/config/{configId}
说明: 根据参数ID获取详细信息
认证: 需要Token
参数: configId路径参数
返回: 参数详细信息
8.4 根据参数键名获取值
URL: GET /system/config/configKey/{configKey}
说明: 根据参数键名获取参数值
认证: 需要Token
参数: configKey路径参数
返回: 参数值
8.5 新增参数配置
URL: POST /system/config
说明: 新增参数配置
认证: 需要Token
参数: {
"configName": "参数名称",
"configKey": "参数键名",
"configValue": "参数键值",
"configType": "系统内置Y是 N否",
"remark": "备注"
}
返回: 操作结果
8.6 修改参数配置
URL: PUT /system/config
说明: 修改参数配置
认证: 需要Token
参数: 参数配置信息对象
返回: 操作结果
8.7 删除参数配置
URL: DELETE /system/config/{configIds}
说明: 批量删除参数配置
认证: 需要Token
参数: configIds路径参数多个用逗号分隔
返回: 操作结果
8.8 刷新参数缓存
URL: DELETE /system/config/refreshCache
说明: 刷新参数缓存
认证: 需要Token
返回: 操作结果
【9. 通知公告模块】
9.1 获取通知公告列表
URL: GET /system/notice/list
说明: 分页查询通知公告列表
认证: 需要Token
参数: {
"noticeTitle": "公告标题(可选)",
"noticeType": "公告类型(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页通知公告列表
9.2 获取通知公告详情
URL: GET /system/notice/{noticeId}
说明: 根据公告ID获取详细信息
认证: 需要Token
参数: noticeId路径参数
返回: 通知公告详细信息
9.3 新增通知公告
URL: POST /system/notice
说明: 新增通知公告
认证: 需要Token
参数: {
"noticeTitle": "公告标题",
"noticeType": "公告类型1通知 2公告",
"noticeContent": "公告内容",
"status": "状态0正常 1关闭"
}
返回: 操作结果
9.4 修改通知公告
URL: PUT /system/notice
说明: 修改通知公告
认证: 需要Token
参数: 通知公告信息对象
返回: 操作结果
9.5 删除通知公告
URL: DELETE /system/notice/{noticeIds}
说明: 批量删除通知公告
认证: 需要Token
参数: noticeIds路径参数多个用逗号分隔
返回: 操作结果
【10. 操作日志模块】
10.1 获取操作日志列表
URL: GET /monitor/operlog/list
说明: 分页查询操作日志列表
认证: 需要Token
参数: {
"title": "操作模块(可选)",
"businessType": "业务类型(可选)",
"status": "操作状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页操作日志列表
10.2 导出操作日志
URL: POST /monitor/operlog/export
说明: 导出操作日志数据
认证: 需要Token
返回: Excel文件流
10.3 删除操作日志
URL: DELETE /monitor/operlog/{operIds}
说明: 批量删除操作日志
认证: 需要Token
参数: operIds路径参数多个用逗号分隔
返回: 操作结果
10.4 清空操作日志
URL: DELETE /monitor/operlog/clean
说明: 清空操作日志
认证: 需要Token
返回: 操作结果
【11. 登录日志模块】
11.1 获取登录日志列表
URL: GET /monitor/logininfor/list
说明: 分页查询登录日志列表
认证: 需要Token
参数: {
"userName": "用户名(可选)",
"status": "状态(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页登录日志列表
11.2 导出登录日志
URL: POST /monitor/logininfor/export
说明: 导出登录日志数据
认证: 需要Token
返回: Excel文件流
11.3 删除登录日志
URL: DELETE /monitor/logininfor/{infoIds}
说明: 批量删除登录日志
认证: 需要Token
参数: infoIds路径参数多个用逗号分隔
返回: 操作结果
11.4 清空登录日志
URL: DELETE /monitor/logininfor/clean
说明: 清空登录日志
认证: 需要Token
返回: 操作结果
【12. 在线用户模块】
12.1 获取在线用户列表
URL: GET /monitor/online/list
说明: 分页查询在线用户列表
认证: 需要Token
参数: {
"ipaddr": "登录地址(可选)",
"userName": "用户名(可选)",
"pageNum": 1,
"pageSize": 10
}
返回: 分页在线用户列表
12.2 强退用户
URL: DELETE /monitor/online/{tokenId}
说明: 强退指定在线用户
认证: 需要Token
参数: tokenId路径参数
返回: 操作结果
【13. 服务监控模块】
13.1 获取服务器信息
URL: GET /monitor/server
说明: 获取服务器监控信息
认证: 需要Token
返回: {
"cpu": "CPU信息",
"mem": "内存信息",
"sys": "系统信息",
"jvm": "JVM信息",
"sysFiles": "磁盘信息"
}
【14. 缓存监控模块】
14.1 获取缓存信息
URL: GET /monitor/cache
说明: 获取缓存监控信息
认证: 需要Token
返回: 缓存信息
14.2 获取缓存名称列表
URL: GET /monitor/cache/getNames
说明: 获取缓存名称列表
认证: 需要Token
返回: 缓存名称列表
14.3 获取缓存键名列表
URL: GET /monitor/cache/getKeys/{cacheName}
说明: 获取指定缓存名称的键名列表
认证: 需要Token
参数: cacheName路径参数
返回: 缓存键名列表
14.4 获取缓存值
URL: GET /monitor/cache/getValue/{cacheName}/{cacheKey}
说明: 获取指定缓存的值
认证: 需要Token
参数: {
cacheName: "缓存名称",
cacheKey: "缓存键名"
}
返回: 缓存值
14.5 清除指定名称缓存
URL: DELETE /monitor/cache/clearCacheName/{cacheName}
说明: 清除指定名称的缓存
认证: 需要Token
参数: cacheName路径参数
返回: 操作结果
14.6 清除指定键名缓存
URL: DELETE /monitor/cache/clearCacheKey/{cacheKey}
说明: 清除指定键名的缓存
认证: 需要Token
参数: cacheKey路径参数
返回: 操作结果
14.7 清除全部缓存
URL: DELETE /monitor/cache/clearCacheAll
说明: 清除全部缓存
认证: 需要Token
返回: 操作结果
【15. 通用功能模块】
15.1 文件下载
URL: GET /common/download
说明: 通用文件下载
认证: 需要Token
参数: {
"fileName": "文件名称",
"delete": true/false // 是否删除文件
}
返回: 文件流
15.2 文件上传(单个)
URL: POST /common/upload
说明: 通用文件上传(单个文件)
认证: 需要Token
参数: {
"file": "文件对象"
}
返回: {
"url": "文件访问URL",
"fileName": "文件名称",
"newFileName": "新文件名称",
"originalFilename": "原始文件名"
}
15.3 文件上传(多个)
URL: POST /common/uploads
说明: 通用文件上传(多个文件)
认证: 需要Token
参数: {
"files": "文件数组"
}
返回: 文件信息数组
15.4 下载资源文件
URL: GET /common/download/resource
说明: 下载资源文件
认证: 需要Token
参数: {
"resource": "资源路径"
}
返回: 文件流
【16. 个人中心模块】
16.1 获取个人信息
URL: GET /system/user/profile
说明: 获取当前登录用户的个人信息
认证: 需要Token
返回: 用户详细信息
16.2 修改个人信息
URL: PUT /system/user/profile
说明: 修改个人信息
认证: 需要Token
参数: {
"nickName": "昵称",
"email": "邮箱",
"phonenumber": "手机号",
"sex": "性别"
}
返回: 操作结果
16.3 修改密码
URL: PUT /system/user/profile/updatePwd
说明: 修改用户密码
认证: 需要Token
参数: {
"oldPassword": "旧密码",
"newPassword": "新密码"
}
返回: 操作结果
16.4 上传头像
URL: POST /system/user/profile/avatar
说明: 上传用户头像
认证: 需要Token
参数: {
"avatarfile": "头像文件"
}
返回: 操作结果
【17. 微信支付模块】
17.1 微信支付查询
URL: GET /system/weixinPayAAA/{orderId}
说明: 查询微信支付订单
认证: 需要Token
参数: orderId路径参数
返回: 支付信息
17.2 微信支付回调
URL: POST /system/weixinBBBBB/wxPayNotify
说明: 微信支付回调通知
认证: 无需Token微信服务器回调
参数: 微信回调数据
返回: 处理结果
17.3 微信支付(新)
URL: GET /system/weixinPayNewBBBB/{orderId}
说明: 创建微信支付订单
认证: 需要Token
参数: orderId路径参数
返回: 支付信息
【18. 系统首页模块】
18.1 系统首页
URL: GET /
说明: 系统首页
返回: 欢迎信息
【19. Swagger文档模块】
19.1 访问Swagger UI
URL: GET /tool/swagger
说明: 跳转到Swagger API文档页面
认证: 需要Token
返回: Swagger UI页面
四、状态码说明
-----------
200: 操作成功
401: 未授权,需要登录
403: 无权限访问
500: 服务器内部错误
五、注意事项
-----------
1. 所有需要认证的接口都需要在请求头中添加Authorization: Bearer {token}
2. Token通过登录接口获取有效期为30分钟
3. 文件上传使用multipart/form-data格式
4. 分页参数pageNum从1开始
5. 删除操作支持批量删除多个ID用逗号分隔
6. 所有时间格式为yyyy-MM-dd HH:mm:ss
7. 状态值0表示正常/启用1表示停用/禁用
六、Swagger文档访问
-----------
Swagger UI地址http://localhost:8039/swagger-ui.html
API文档地址http://localhost:8039/dev-api/v3/api-docs
需要先登录获取Token后访问
========================================
文档版本v1.0
最后更新2024年
========================================