总体
1、接口
返回数据的格式:
-1 | 0 | 1 |
---|---|---|
敏感接口需要登录 | 查询失败 | 查询成功 |
{
code: 0, // 状态码,
result: [{},{}], // 返回的数据
msg: "info" // 信息,成功或者错误提示信息
}
注:接口名称加粗的表示需要登录,返回数据加粗表示重要信息必须返回
1.1、普通用户接口
接口名称 | 接口地址 | 请求方法 | 参数 | 返回数据 |
---|---|---|---|---|
登录 | /api/user/login | post | {account,password} | nickname,id |
注册 | /api/user/register | post | {account,nickname,password} | nickname,id |
关注/取关他人 | /api/user/vote | get | 被关注者用户id,用户id,关注还是取关 | |
获取关注者列表 | /api/user/follower | get | ||
获取用户关注的用户列表 | /api/user/follwing | |||
用户详情 | /api/user/info?id=id | get | id | |
获取用户自定义的标签 | /api/user/gettag?id=id | get | id | |
用户添加自定义标签 | /api/user/addtag?id=id | post | tags,id | |
获取用户发表的文章 | /api/user/article?id=id | get | 用户id | 文章列表 |
用户反馈 | /api/feedback/add | post | 反馈信息,用户id | |
文章列表 | /api/article/list?page=1&size=1 | get | {page, size} | 返回文章id,以及重要信息,发表的用户 |
文章详情 | /api/article/info?id=id | get | {文章id} | 文章信息,和上面差不多 |
文章点赞 | /api/article/vote | get | 文章id | 返回是否点赞成功即可 |
文章评论 | /api/article/comment | post | 文章id,用户id,评论 | |
发表文章 | /api/article/add | post | 用户id,文章信息 | |
获取所有标签 | /api/tag/list | get | ||
1.2、管理员接口
管理员的所有操作必须登录,具体权限具体分配,目前先暂时不考虑权限问题,一个超级用户即可。
接口名称 | 接口地址 | 请求方法 | 参数 | 返回数据 |
---|---|---|---|---|
登录 | /api/suser/login | post | {account,password} | nickname,id |
注册 | /api/suser/register | post | {account,nickname,password} | nickname,id |
获取用户自定义的标签 | /api/user/gettag?id=id | get | id | |
用户添加自定义标签 | /api/user/addtag?id=id | post | tags,id | |
获取用户发表的文章 | /api/user/article?id=id | get | 用户id | 文章列表 |
用户反馈 | /api/feedback/add | post | 反馈信息,用户id | |
文章列表 | /api/article/list?page=1&size=1 | get | {page, size} | 返回文章id,以及重要信息,发表的用户 |
文章详情 | /api/article/info?id=id | get | {文章id} | 文章信息,和上面差不多 |
文章点赞 | /api/article/vote | get | 文章id | 返回是否点赞成功即可 |
文章评论 | /api/article/comment | post | 文章id,用户id,评论 | |
发表文章 | /api/article/add | post | 用户id,文章信息 | |
获取所有标签 | /api/tag/list | get | ||