本文详细介绍了一个类似微信朋友圈的社交应用的API设计，包括登录、注册、消息发布与获取等功能的具体实现方式，以及用户资料和个人设置等接口的设计。
开启第一版本的迭代设计，互动朋友圈API设计，上篇文章公布了我们的初稿原型图设计。
该APP类似微信朋友圈，添加好用功能类似微博添加好友的那种关注与被关注的形式。运营形式类似于快手！
互动朋友圈API设计
1 //概要 2 //基本数据 3 //Account 账户 4 /** 5 * Id 6 * Account 用户名：邮箱/手机号（当前选邮箱） 7 * Pwd 密码 8 * createdAt 创建时间 9 * updatedAt 修改时间 10 * deletedAt 逻辑删除 11 */ 12 //User 用户 13 /** 14 * Id 15 * PicUrl 头像 16 * Nmae 昵称 17 * Sign 签名 18 * createdAt 创建时间 19 * updatedAt 修改时间 20 * deletedAt 逻辑删除 21 */ 22 //Message 消息 23 /** 24 * Id 25 * Content 消息内容 26 * createdAt 创建时间 27 * updatedAt 修改时间 28 * deletedAt 逻辑删除 29 */ 30 //Image 图像 31 /** 32 * Id 33 * PicUrl 消息图片 34 * createdAt 创建时间 35 * updatedAt 修改时间 36 * deletedAt 逻辑删除 37 */ 38 //Comment 评论 39 /** 40 * Id 41 * Content 评论内容 42 * createdAt 创建时间 43 * updatedAt 修改时间 44 * deletedAt 逻辑删除 45 */
一、登录
请求地址：http://192.168.2.8020/api/Login
请求方式：POST
请求参数：
参数名 说明 name 用户名 pwd 密码
返回值：
//成功
{
success:true,
token:'xxxx',
message:'登录成功！'
}
//失败
{
success:false,
message:'登录失败！',
}
二、注册
请求地址：http://192.168.2.8020/api/Register
请求方式：POST
请求参数：
参数名 说明 name 注册用户名 pwd 注册密码 返回值：
//成功
{
success:true,
token:'xxxxx',
message:'注册成功！'
}
//失败
{
success:false,
message:'注册失败！',
}
三、消息
请求地址：http://192.168.2.8020/api/Message/GetAllMessage
请求方式：GET
请求参数：
参数 说明 type 0获取全部人的消息
1获取我关注人的消息
默认0
返回值：
1 //成功 2 { 3 success: true 4 data: [ 5 { 6 id: 1, 7 content: 'xxxxx', 8 createAt:'2017年7月25日16:46:22', 9 user: { 10 id: 1, 11 picUrl: 'xxxx', 12 }, 13 comment: [ 14 { 15 id:'2', 16 comment:'xxxx', 17 user: { 18 id: 1, 19 picUrl: 'xxxx', 20 } 21 } 22 //... 23 ], 24 image:[ 25 { 26 id:1, 27 picUrl:'xxxx', 28 } 29 //.... 30 ] 31 } 32 //... 33 ] 34 }
//失败
{
success:false,
message:'网络异常',
}
四、我的
请求地址：http://192.168.2.8020/api/Message/GetMyMessage
请求方式：GET
请求参数：
参数名 说明 token 个人令牌 返回值：
//成功
1 //成功 2 { 3 success: true 4 data: [ 5 { 6 id: 1, 7 content: 'xxxxx', 8 createAt:'2017年7月25日16:46:22', 9 user: { 10 id: 1, 11 picUrl: 'xxxx', 12 }, 13 comment: [ 14 { 15 id:'2', 16 comment:'xxxx', 17 user: { 18 id: 1, 19 picUrl: 'xxxx', 20 } 21 } 22 //... 23 ], 24 image:[ 25 { 26 id:1, 27 picUrl:'xxxx', 28 } 29 //.... 30 ] 31 } 32 //... 33 ] 34 }
//失败
{
success:false,
message:'网络异常',
}
//修改
十四、删除我发布的某条消息
请求地址：http://192.168.2.8020/api/Message/DelMyMessage
请求方式：POST
请求参数：
参数 说明 token 个人令牌 messageId 要删除的消息ID 返回值：
//成功
{
success:true,
message:'删除成功！',
}
//失败
{
success:false,
message:'网络异常',
}
五、朋友
请求地址：http://192.168.2.8020/api/Friends
请求方式：GET
请求参数：
参数名 说明 token 个人令牌 返回值：
//成功
{
success:true,
data:[
{
pictureUrl:'xxxxxxx',
name:'xxxx',
sign:'xxxxx',
}，
....
]
}
//失败
{
success:false,
message:'网络异常！',
}
六、发布消息
请求地址：http://192.168.2.8020/api/PublicMsg
请求方式：POST
请求参数：
参数 说明 token 个人令牌 content 发布消息 image 添加图片（数组、对象）
返回值：
//成功
{
success:true,
message:'发布成功！'，
}
//失败
{
success:false,
message:'发布失败！',
}
补充：发布评论
请求地址：http://192.168.2.8020/api/PubComment
请求方式：POST
请求参数：
参数 说明 token 个人令牌 content
messageId
发布消息
要评论的消息ID
返回值：
//成功
{
success:true,
message:'评论成功！'，
}
//失败
{
success:false,
message:'评论失败！',
}
七、帮助
请求地址：http://192.168.2.8020/api/Help
请求方式：GET
请求参数：无
返回值：
//成功
{
success:true,
data:'xxxxxxxxx',//返回的操作手册，操作指导
}
//失败{
successs:false,
message:'网络异常！',
}
//个人资料模块
八、获取某个人（不一定是朋友）的基本资料
请求地址：http://192.168.2.8020/api/getOnePersonMsg
请求方式：GET
请求参数：
参数 说明 userId 要查看某人的ID 返回值：
//成功
{
success:true,
data:{
pictureUrl:'xxxx',
sign:'xxxxx',
name:'xxxx',//昵称
}
}
//失败{
successs:false,
message:'网络异常',
}
九、获取某人发过的朋友圈
请求地址：http://192.168.2.8020/api/getOnePersonMsgExt
请求方式：GET
请求参数：
参数 说明 userId 要查看某人的ID 返回值：
1 //成功 2 { 3 success: true 4 data: [ 5 { 6 id: 1, 7 content: 'xxxxx', 8 createAt:'2017年7月25日16:46:22', 9 user: { 10 id: 1, 11 picUrl: 'xxxx', 12 }, 13 comment: [ 14 { 15 id:'2', 16 comment:'xxxx', 17 user: { 18 id: 1, 19 picUrl: 'xxxx', 20 } 21 } 22 //... 23 ], 24 image:[ 25 { 26 id:1, 27 picUrl:'xxxx', 28 } 29 //.... 30 ] 31 } 32 //... 33 ] 34 }
//失败
{
success:false,
message:'网络异常！',
}
十、关注某人
请求地址：http://192.168.2.8020/api/Followed
请求方式：POST
请求参数：
参数 说明 token 个人令牌 userId 关注人ID
返回值：
//成功
{
success：true,
message:'关注成功！',
}
//失败
{success:false,
message:'关注失败！',
}
十一、设置头像
请求地址：http://192.168.2.8020/api/SetMyPicture
请求方式：POST
请求参数：
参数 参数说明 token 个人令牌 pictureUrl 上传的头像路径
返回值：
//成功
{
success:true,
message:'设置头像成功！',
}
//失败
{success:false,
message:'网络异常！',
}
//余下两个，与上一个大体相近，这里就不在写了
十二、设置用户名//修改昵称
请求地址：http://192.168.2.8020/api/SetMyName
请求方式：POST
请求参数：
参数 参数说明 token 个人令牌 name
要修改的昵称
返回值：
//成功
{
success:true,
message:'设置用户名成功！',
}
//失败
{success:false,
message:'网络异常！',
}
十三、设置密码
请求地址：http://192.168.2.8020/api/SetMyPwd
请求方式：POST
请求参数：
参数
说明 token 个人令牌 curentPwd
newPwd
旧密码
新密码
返回值：
//成功
{
success:true,
message:'设置密码成功！',
}
//失败
{success:false,
message:'网络异常！',
}
新增忘记密码API
十四、忘记密码
请求地址：http://192.168.2.8020/api/ForgetPwd
请求方式：POST
请求参数：
参数 说明 token 个人令牌
个人邮箱
返回值：
//成功
{
success：true,
message:'已为返回密码注意查收',
}
//失败
{
success:false,
message:'网络异常，请再次尝试！'
}
好累啊，终于写完了，最近两天心比较累，如有疑问请联系作者，如有错误，请留言！
扫一扫
562
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
