172 lines
4.5 KiB
Markdown
172 lines
4.5 KiB
Markdown
# UserApi 接口文档
|
||
|
||
## 简介
|
||
UserApi类提供了用户相关的所有API接口，包括用户认证、个人信息管理、作品管理、社交关系等功能。
|
||
|
||
## 认证相关接口
|
||
|
||
### 登录
|
||
- **方法**: `getLogin(data)`
|
||
- **请求**: POST `/app/system/loginPassword`
|
||
- **参数**: data对象
|
||
- **说明**: 账号密码登录
|
||
- **Token要求**: 否
|
||
|
||
### 短信验证码登录
|
||
- **方法**: `getLoginCode(data)`
|
||
- **请求**: POST `/app/system/loginSms`
|
||
- **参数**: data对象
|
||
- **说明**: 使用短信验证码进行登录
|
||
- **Token要求**: 否
|
||
|
||
### 注册
|
||
- **方法**: `getRegister(data)`
|
||
- **请求**: POST `/app/system/register`
|
||
- **参数**: data对象
|
||
- **说明**: 注册新用户
|
||
- **Token要求**: 否
|
||
|
||
### 发送验证码
|
||
- **方法**: `getSendCode(phone)`
|
||
- **请求**: GET `/appCaptchaCode/${phone}`
|
||
- **参数**: phone (手机号)
|
||
- **说明**: 发送短信验证码
|
||
- **Token要求**: 否
|
||
|
||
### 退出登录
|
||
- **方法**: `getLogout()`
|
||
- **请求**: GET `/app/system/logOut`
|
||
- **说明**: 用户退出登录
|
||
- **Token要求**: 是
|
||
|
||
## 用户信息管理
|
||
|
||
### 获取用户信息
|
||
- **方法**: `getSetting(phone)`
|
||
- **请求**: GET `/app/system/getUserInfo/${phone}`
|
||
- **参数**: phone (手机号)
|
||
- **说明**: 获取用户基本信息
|
||
- **Token要求**: 是
|
||
|
||
### 实名认证
|
||
- **方法**: `getRealNameAuth(data)`
|
||
- **请求**: POST `/app/system/realNameAuthentication`
|
||
- **参数**: data对象
|
||
- **说明**: 用户实名认证
|
||
- **Token要求**: 是
|
||
|
||
### 更新用户信息
|
||
- **方法**: `getUpdateUserInfo(data)`
|
||
- **请求**: POST `/app/system/updateNickSign`
|
||
- **参数**: data对象
|
||
- **说明**: 更新用户昵称和介绍
|
||
- **Token要求**: 是
|
||
|
||
### 更新背景图
|
||
- **方法**: `getUpdateUserBg(data)`
|
||
- **请求**: POST `/app/system/changeBackground`
|
||
- **参数**: data对象
|
||
- **说明**: 更换用户背景图片
|
||
- **Token要求**: 是
|
||
|
||
## 密码管理
|
||
|
||
### 修改密码
|
||
- **方法**: `getChangePassword(data)`
|
||
- **请求**: PUT `/app/system/updatePwd`
|
||
- **参数**: data对象
|
||
- **说明**: 更改密码
|
||
- **Token要求**: 是
|
||
|
||
### 忘记密码
|
||
- **方法**: `getForgetPassword(data)`
|
||
- **请求**: PUT `/app/system/forgetPassword`
|
||
- **参数**: data对象
|
||
- **说明**: 重置忘记的密码
|
||
- **Token要求**: 否
|
||
|
||
## 作品管理
|
||
|
||
### 创建作品
|
||
- **方法**: `getUserWorks(data)`
|
||
- **请求**: POST `/app/system/createUserWork`
|
||
- **参数**: data对象
|
||
- **说明**: 用户创作新作品
|
||
- **Token要求**: 是
|
||
|
||
### 获取我的发布
|
||
- **方法**: `getMyPublish()`
|
||
- **请求**: GET `/app/system/getUserPublishWork`
|
||
- **说明**: 获取用户发布的作品列表
|
||
- **Token要求**: 是
|
||
|
||
### 获取作品集
|
||
- **方法**: `getMyCollection()`
|
||
- **请求**: GET `/app/system/getUserPublishWorkList`
|
||
- **说明**: 获取用户的作品集
|
||
- **Token要求**: 是
|
||
|
||
### 草稿箱管理
|
||
- **方法**: `getDrafts()`
|
||
- **请求**: GET `/app/system/getUserDraftWorkList`
|
||
- **说明**: 获取草稿箱作品列表
|
||
- **Token要求**: 是
|
||
|
||
### 删除草稿
|
||
- **方法**: `deleteDraft(workId)`
|
||
- **请求**: DELETE `/app/system/deleteUserWork/${workId}`
|
||
- **参数**: workId (作品ID)
|
||
- **说明**: 删除草稿箱中的作品
|
||
- **Token要求**: 是
|
||
|
||
## 社交关系
|
||
|
||
### 关注列表
|
||
- **方法**: `getMyFollow()`
|
||
- **请求**: GET `/app/system/getFollowerList`
|
||
- **说明**: 获取我关注的用户列表
|
||
- **Token要求**: 是
|
||
|
||
### 粉丝列表
|
||
- **方法**: `getMyFans()`
|
||
- **请求**: GET `/app/system/getFollowedList`
|
||
- **说明**: 获取关注我的用户列表
|
||
- **Token要求**: 是
|
||
|
||
### 取消关注
|
||
- **方法**: `cancelFollow(followedUserId)`
|
||
- **请求**: GET `/app/system/deleteFollower/${followedUserId}`
|
||
- **参数**: followedUserId (被关注用户ID)
|
||
- **说明**: 取消关注某用户
|
||
- **Token要求**: 是
|
||
|
||
## 消息通知
|
||
|
||
### 系统消息
|
||
- **方法**: `getSystemMessage()`
|
||
- **请求**: GET `/app/system/systemMessage`
|
||
- **说明**: 获取系统消息列表
|
||
- **Token要求**: 是
|
||
|
||
### 消息详情
|
||
- **方法**: `getMessageDetail(id)`
|
||
- **请求**: GET `/app/system/getSystemMessageDetail/${id}`
|
||
- **参数**: id (消息ID)
|
||
- **说明**: 获取指定消息的详细内容
|
||
- **Token要求**: 是
|
||
|
||
### 点赞相关
|
||
- **方法**: `getAddLikeNum()`
|
||
- **请求**: GET `/app/system/addLikeCount`
|
||
- **说明**: 获取新增点赞数
|
||
- **Token要求**: 是
|
||
|
||
- **方法**: `getLikeList()`
|
||
- **请求**: GET `/app/system/getWorkLikeList`
|
||
- **说明**: 获取点赞列表
|
||
- **Token要求**: 是
|
||
|
||
## 注意事项
|
||
1. 所有需要token的接口都必须在用户登录后调用
|
||
2. 请求失败时会返回相应的错误信息
|
||
3. 部分接口的具体参数格式需要参考具体业务需求 |