更新登录接口说明

This commit is contained in:
谷成伟 2024-06-21 09:50:00 +08:00
parent 989bfe8979
commit 898b7734b5
2 changed files with 21 additions and 37 deletions

View File

@ -7,7 +7,6 @@ import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.das.common.captcha.CaptchaUtil;
import com.das.common.config.SaTokenProperties;
import com.das.common.exceptions.ServiceException;
import com.das.common.utils.AESUtil;
import com.das.common.utils.AdminRedisTemplate;
import com.das.modules.auth.domain.LoginUserDetails;
@ -18,7 +17,6 @@ import com.das.modules.auth.entity.SysUser;
import com.das.modules.auth.mapper.SysUserMapper;
import com.das.modules.auth.service.ILoginService;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import jakarta.annotation.Resource;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

View File

@ -14,7 +14,7 @@
| 参数名称 | 说明 | 备注 |
| -------- | -------- | --- |
| Token | 令牌 | 需要鉴权的API 才需要添加此参数 |
| token | 令牌 | 需要鉴权的API 才需要添加此参数 |
| V | 加密向量 | 必须添加 |
加密采用AES/CBC/ZeroPadding加密方式密钥长度为16位。IV长度为16位每次请求时随机生成
@ -25,13 +25,13 @@
| 接口分类 | 接口描述 | API接口 | 权限 |
|:-----:| :------- |:--------------------------|-----------------|
| 获取验证码 | 获取验证码 | /api/captchaImage | |
| 获取验证码 | 获取验证码 | /api/auth/captchaImage | |
| 系统登录 | 系统登录 | /api/auth/login | /XXXX/XXX/XXX/X |
| 系统登录 | 退出登录 | /api/auth/revoke | |
| 系统登录 | 退出登录 | /api/auth/logout | |
| 系统登录 | 修改密码 | /api/auth/password/change | |
## 验证码获取
> /api/captchaImage
> /api/auth/captchaImage
入参示例
@ -44,9 +44,9 @@
"code": 200,
"msg": "操作成功",
"data": {
"img": "",
"uuid": "9007a0158f7c4635b4e6e577de7406e0"
}
"img": "",
"uuid": "9007a0158f7c4635b4e6e577de7406e0"
}
}
```
调用成功返回描述
@ -60,7 +60,7 @@
使用用户名和密码验证码和验证码的唯一标识登录系统POST请求
> /api/auth/invoke
> /api/auth/login
入参示例
@ -98,29 +98,15 @@
| 变量名 | 变量类型 | 可为NULL | 描述 |
| -------------------- |--------| -------- | -------------------------- |
| token | String | No | 令牌 |
| token | String | No | 令牌(未加密) |
## 退出登录
注销令牌退出登录POST请求
> /api/auth/revoke
> /api/auth/logout
入参示例
```json
{
"userName":"xx",
"token":"xxx"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| -------- | -------- | ---- | ------ |
| userName | String | no | 用户名 |
| token | String | no | token |
无入参
调用成功返回示例
@ -136,16 +122,15 @@
修改登录密码POST请求
api/auth/password/change
> api/auth/password/change
入参示例
```
```json
{
"userName":"xx",
"oldPassword":"xx",
"newPassword":"xxx",
"token":"xxx"
"userName":"xx",
"oldPassword":"xx",
"newPassword":"xxx",
}
```
@ -156,18 +141,19 @@ api/auth/password/change
| oldPassword | String | NO | 旧密码 |
| newPassword | String | NO | 新密码 |
| userName | String | NO | 用户名 |
| token | String | NO | token |
调用成功返回示例
```json
{
"code":"200",
"msg":"修改成功",
"data":"null"
"code":"200",
"msg":"修改成功",
"data":"null"
}
```
!> 下面的文档有待确认
# 公司机构模块API接口
组织机构模块提供的API包括机构查询、添加、修改等功能。