diff --git a/docs/api/api_list.md b/docs/api/api_list.md index 9353055d..29958eaa 100644 --- a/docs/api/api_list.md +++ b/docs/api/api_list.md @@ -13,15 +13,42 @@ ## API接口一览表 -| 接口分类 | 接口描述 | API接口 | 权限 | -| :------: | :------- | :------------------------ | --------------- | -| 系统登录 | 系统登录 | /api/auth/invoke | /XXXX/XXX/XXX/X | -| 系统登录 | 退出登录 | /api/auth/revoke | | -| 系统登录 | 修改密码 | /api/auth/password/change | | +| 接口分类 | 接口描述 | API接口 | 权限 | +|:-----:| :------- |:--------------------------|-----------------| +| 获取验证码 | 获取验证码 | /api/captchaImage | | +| 系统登录 | 系统登录 | /api/auth/login | /XXXX/XXX/XXX/X | +| 系统登录 | 退出登录 | /api/auth/revoke | | +| 系统登录 | 修改密码 | /api/auth/password/change | | + +## 验证码获取 +> /api/captchaImage + + +入参示例 + +无入参 + +调用成功返回示例 +```json +{ + "code": 200, + "msg": "操作成功", + "data": { + "img": "", + "uuid": "9007a0158f7c4635b4e6e577de7406e0" + } +} +``` +调用成功返回描述 + +| 变量名 | 变量类型 | 可为NULL | 描述 | +| -------------------- |--------| -------- |------------| +| img | String | No | 图片base64编码 | +| uuid | String | No | 验证码唯一标志 | ## 系统登录 -使用用户名和密码登录系统,POST请求 +使用用户名和密码,验证码和验证码的唯一标识登录系统,POST请求 > /api/auth/invoke @@ -30,39 +57,38 @@ ```json { "userName":"xx", - "password":"xxx" + "password":"xxx", + "code":"xxx", + "uuid":"xxx" } ``` 入参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -| -------- | -------- | ---- | -------- | -| userName | String | no | 用户名 | +| 参数名 | 参数类型 | 可选 | 描述 | +| -------- | -------- | ---- |------| +| userName | String | no | 用户名 | | password | String | no | 用户密码 | +| code | String | no | 验证码 | +| uuid | String | no | 唯一标志 | 调用成功返回示例 ```json { - "code":"200", - "data": - { - "token": "xxx", - "tokenTimeout": "xxx", - "tokenActivityTimeout": "xxx" - }, - "msg":"登陆成功" + "code": 200, + "msg": "操作成功", + "data": { + "token": "eyJhbGciOiJIUzUxMiJ9.eyJsb2dpbl91c2VyX2tleSI6ImMyNjg3ZGI4LWJkNmItNGE3OC05MTI0LWMyNDk2NzNlNTZkOSJ9.NXnDQyHdJcz8md95DLkETJqY91048X2X_yPcCRRejLRf0p0Nz1cC4kNti0RAE5PdX477O3d27a35S4C2_VM54Q" + } } ``` 调用成功返回描述 -| 变量名 | 变量类型 | 可为NULL | 描述 | -| -------------------- | -------- | -------- | -------------------------- | -| token | Integer | No | 令牌值 | -| tokenTimeout | String | No | 令牌超时时间,单位(秒) | -| tokenActivityTimeout | String | No | 令牌活动超时间隔,单位(秒) | +| 变量名 | 变量类型 | 可为NULL | 描述 | +| -------------------- |--------| -------- | -------------------------- | +| token | String | No | 令牌值 | ## 退出登录