218 lines
8.7 KiB
Markdown
218 lines
8.7 KiB
Markdown
## 1：接口说明
|
||
|
||
测试阶段接口基地址：
|
||
|
||
- 1：App数据接口：http://127.0.0.1:8090/app
|
||
- 2：后台数据接口：http://127.0.0.1:8090/admin
|
||
|
||
正式阶段接口：**（前端用这个）**
|
||
|
||
- 1：App数据接口：https://moehu.net/app
|
||
- 2：后台数据接口：https://moehu.net/admin
|
||
|
||
接口文档地址：
|
||
|
||
- https://moehu.net/swagger-ui.html
|
||
- http://127.0.0.1:8090/swagger-ui.html
|
||
|
||
返回数据格式如下：
|
||
|
||
```txt
|
||
{
|
||
"code": 操作的状态码,
|
||
"message": 操作的提示信息,
|
||
"data": 返回的具体数据
|
||
}
|
||
```
|
||
|
||
**注意：**
|
||
|
||
`code` 取值有：
|
||
|
||
- 200：表示成功获取到`data`数据
|
||
- 100：表示操作成功，但是不需要返回data数据给前端，所以`data == null`，只是返回一个操作状态的文字提示（例如用户修改，删除）
|
||
- 404：表示没有获取到`data`数据，所以返回错误的具体信息。
|
||
- 500：表示系统级别的错误，一般后端程序出错，缺少`token`，或者用户不存在等
|
||
- 403：表示token失效，需要前端重定向登录页面重新登录
|
||
|
||
前端根据 `code` 的取值的不同需要自行在拦截器里面处理各种情况，一般建议如下处理：
|
||
- `code == 200` ：返回data中的数据给前端页面使用
|
||
- `code == 100` ：不返回数据给前端页面，不需要toast提示用户
|
||
- `code == 404` ：不返回数据给前端页面，但需要toast提示用户
|
||
- `code == 500` ：不返回数据给前端页面，但需要弹窗提示用户！
|
||
- `code == 403` ：不返回数据给前端页面，但需要弹窗提示用户，强制用户进行某些操作！
|
||
|
||
## 1：任务计划
|
||
|
||
> 前台App功能
|
||
|
||
- 1：集成接口文档 【完成】
|
||
- 2：实现接口调用日志【完成】
|
||
- 3：Nodejs+Shell 实现 自动化部署【完成】
|
||
- 4：接口token 【完成】
|
||
- 5：实现接口限流
|
||
---
|
||
- 6：查看作品详情接口
|
||
- 6.1：作品的主要数据 **【完成】**
|
||
- 6.2：获取 该作品 评论 的数据 **【完成】**
|
||
- 6.3：获取 该作品 发布用户信息 的数据 **【完成】**
|
||
- 6.4：获取 该作品 标签 的数据，关联任务8 **【完成】**
|
||
- 6.5：点赞接口，取消点赞接口，查询作品是否被点赞接口 **【完成】**
|
||
- 说明：用户可以在点赞的界面，取消点赞。用户不可以用查看点赞过的作品
|
||
- 6.6：收藏作品相关的功能
|
||
- 收藏接口 **【完成】**
|
||
- 取消收藏接口 **【完成】**
|
||
- 个人空间获取收藏列表接口。**【完成】**
|
||
- 简单版的作品详情接口（只返回作品图片）
|
||
- 说明：用户只可以在个人空间中查看收藏的作品（功能类似于个人相册）
|
||
该相册中查看已收藏的作品，查阅作品时不会跳转到之前点赞收藏的页面，而是独立的简单的图片预览，类似手机自带相册的预览方式。
|
||
|
||
---
|
||
- 7：发布评论接口【完成】，获取评论列表【完成】，删除评论接口【完成】 和 举报他人评论接口
|
||
|
||
- 说明：用户评论发布后，可以在发布评论的地方进行删除评论，如果是他人的评论可以对他人的言论进行举报，并备注举报理由
|
||
---
|
||
- 8：发布作品（作品是画（图片）） 接口
|
||
- 8.1：上传文件接口 **【完成】**
|
||
- 8.2：获取推荐标签接口 **【完成】**
|
||
- 8.3：创建标签接口 **【完成】备注：需要在创建作品成功后调用创建标签的service方法**
|
||
- 8.4：获取作品的标签 接口 **【完成】**
|
||
- 8.5：点击标签，查看该标签下作品列表 接口 **【完成】**
|
||
- 8.6：用户创建的标签自己可以编辑删除，管理员可以后台进行删除操作
|
||
- 获取用户自己创建的所有标签 **【完成】**
|
||
- 修改创建的标签 **【完成】**
|
||
- 删除创建的标签 **【完成】**
|
||
---
|
||
- 9：搜索接口
|
||
- 说明
|
||
- 关联 2.3
|
||
---
|
||
- 10：登录，注册，短信验证等接口
|
||
- 说明：
|
||
- 短信验证码阿里云未通过审核
|
||
- 登录注册需要对接需求后修改
|
||
---
|
||
- 11：首页获取 推荐 列表的接口 **【完成】**
|
||
- 说明：
|
||
- 按照最新发布的作品进行排序，水平比较低的，可以再审核的那一环，选择不展示再首页的最新推荐中
|
||
|
||
- 12：首页获取 排行 列表的接口 **【完成】**
|
||
- 说明：
|
||
- 排行 按照 点赞量 收藏量 下载量 评论量 还自定义算法
|
||
- 作品点赞数×0.1+作品浏览量×0.2+作品的关注数量×0.15+评论量×0.2=权重分数
|
||
|
||
|
||
- 13：首页获取 关注 列表的接口 **【完成】**
|
||
- 说明：
|
||
- 只展示自己关注用户的作品
|
||
|
||
|
||
- 14：修改资料接口
|
||
- 说明：
|
||
- 需要详细PSD，和进一步需求沟通
|
||
|
||
- 15：联系客服 集成第三方
|
||
- 16：关注作品接口，取消关注接口，查询当前用户是否被关注接口 **【完成】**
|
||
- 说明：可以取消关注，可以在任何有关注该用户的地方，重新点击已关注的按钮，进行取消关注（关注某个用户，关注按钮会默认变为已关注）关注列表中也可以快捷取消关注
|
||
|
||
> 后台功能
|
||
|
||
- 1：作品审核
|
||
---
|
||
- 2：头像审核
|
||
- 3：昵称审核
|
||
- 4：签名审核
|
||
|
||
说明：这三个可以先通过，审核不过可以再驳回，因为这个肯定是要管理的。
|
||
|
||
---
|
||
- 5：作品举报审核
|
||
- 6：热门推荐顺序
|
||
|
||
---
|
||
|
||
## 2：需求沟通整理
|
||
|
||
### 2.1：动态和作品有什么区别？
|
||
|
||
作品是画（图片），可以点赞 收藏 付费下载
|
||
|
||
动态就是类似于朋友圈 空间说说，动态（类似于朋友圈 空间说说）分两种情况
|
||
|
||
```text
|
||
1：个人空间中动态：展示用户自己发的动态
|
||
2：首页底部中动态：展示用户关注人的动态
|
||
|
||
1：用户发布作品的时候
|
||
|
||
功能：是否勾选【同步至动态】按钮
|
||
|
||
结果1（投稿动态）：勾选后，那么该作品将同时出现在 动态 和 作品中，并且可以在标签，搜索，排行中等功能中正常被使用到
|
||
牵连的功能：如果动态列表中的 【投稿动态】 被点击，那么直接进入作品详情页面来查看作品
|
||
|
||
结果2（普通动态）：未勾选，那么该作品只会出现动态中。
|
||
牵连的功能：如果动态列表中的 【普通动态】 被点击，那么应该进入动态详情页面来查看动态
|
||
```
|
||
|
||
### 2.2：那么动态是否需要做成类似作品那样？用户可以发布自己的动态？对自己的动态进行删除修改？动态是否也需要作品那样的评论，点赞，举报等一些列功能？
|
||
|
||
用户可以在个人空间发布自己的动态，自己的动态如果添加（标签/话题）就会在动态中心被搜索，如果不添加，仅展示给已关注我的人，或者是好友（好友属于后续阶段的社交功能），但是如果别人进入了个人空间，动态都是任何访客都可预览的，动态中心的动态，和个人空间的动态。都和发布作品一样的评论功能，可以留言，可以举报（动态可以删除，但是不了修改内容，只能重发）
|
||
|
||
### 2.3：作品只有一张图，更多图片可以去个人空间阅览
|
||
|
||
没看明白具体意思，未详细沟通需求！
|
||
|
||
### 2.4：首页的搜索针对作品进行吗？如果针对作品，那么提供哪些关键词搜索方式？作品名，作者名 还是？
|
||
|
||
首页的搜索，可以搜索作品名，角色名，游戏名，番剧名，（标签/话题），作者昵称，作者id，作品id
|
||
|
||
### 2.5：我的空间，动态 等页面也有搜索功能，问题同 2.4！
|
||
|
||
未详细沟通需求！
|
||
|
||
---
|
||
|
||
## 3：需要客户提供的资料
|
||
|
||
### 3.1 暂缺的PSD图：
|
||
|
||
- 1：首页的排行 **【已提供】**
|
||
- 2：动态的发布页面 **【已提供】**
|
||
- 3：登录，注册 **【已提供】**
|
||
- 4：编辑资料点进去页面 **【已提供】**
|
||
- 5：首页顶部搜索输入框点击进入后的页面 **【已提供】**
|
||
- 6：抽屉里面的设置页面 **【已提供】**
|
||
- 7：标签管理页面 **【已提供】**
|
||
- 8：动态的详情页面 **【已提供】**
|
||
- 9：首页 关注页面
|
||
- 10：首页，动态 搜索后的列表页面
|
||
- 11：主题页面
|
||
- 12：各个动态页面 右上角 图标 点开后 样式
|
||
|
||
### 3.2 第三方资料和配置
|
||
|
||
- 1：服务器 【完成】
|
||
- 2：存片存储 （阿里云oss 或者 七牛云）**【完成】**
|
||
- 3：HTTPS 证书的开通 **【完成】**
|
||
- 6：申请域名（注册阿里账号，域名备案）**【完成】**
|
||
|
||
- 4：短信验证码 平台 **【审核】**
|
||
- 9：android 平台上架申请账号 **【正在进行】**
|
||
- 5：微信 & 支付宝支付 申请 **【可以同步开始】**
|
||
|
||
- 7：第三方客服
|
||
|
||
- 8：苹果开发者证书
|
||
|
||
|
||
### 3.3 客户基本信息
|
||
|
||
- 应用名称：萌弧
|
||
- 公司名称：安徽虚拟纪元科技有限公司
|
||
- 已备案的网站：没有
|
||
|
||
|
||
|
||
|
||
|