ReactNative朋友圈API设计

//概要
//基本数据
//Account 账户
/**
* Id
* Account 用户名：邮箱/手机号（当前选邮箱）
* Pwd 密码
* createdAt 创建时间
* updatedAt 修改时间
* deletedAt 逻辑删除
*/

//User 用户
/**
* Id
* PicUrl 头像
* Nmae 昵称
* Sign 签名
* createdAt 创建时间
* updatedAt 修改时间
* deletedAt 逻辑删除
*/

//Message 消息
/**
* Id
* Content 消息内容
* createdAt 创建时间
* updatedAt 修改时间
* deletedAt 逻辑删除
*/

//Image 图像
/**
* Id
* PicUrl 消息图片
* createdAt 创建时间
* updatedAt 修改时间
* deletedAt 逻辑删除
*/

//Comment 评论
/**
* Id
* Content 评论内容
* createdAt 创建时间
* updatedAt 修改时间
* deletedAt 逻辑删除
*/

一、登录
请求地址：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

返回值：

 //成功
 {
     success: true
     data: [
         {
             id: 1,
             content: 'xxxxx',
             createAt:'2017年7月25日16:46:22',
             user: {
                 id: 1,
                 picUrl: 'xxxx',
             },
             comment: [
                 {
                     id:'2',
                     comment:'xxxx',
                     user: {
                         id: 1,
                         picUrl: 'xxxx',
                     }
                 }
                //...
             ],
             image:[
                 {
                     id:1,
                    picUrl:'xxxx',
                 }
                 //....
             ]
         }
         //...
     ]
 }

//失败
{
　　success:false,

　　message:'网络异常',
}

四、我的
请求地址：http://192.168.2.8020/api/Message/GetMyMessage
请求方式：GET
请求参数：
参数名 说明
token 个人令牌
返回值：

//成功
 {
     success: true
     data: [
         {
             id: 1,
             content: 'xxxxx',
             createAt:'2017年7月25日16:46:22',
             user: {
                 id: 1,
                 picUrl: 'xxxx',
             },
             comment: [
                 {
                     id:'2',
                     comment:'xxxx',
                     user: {
                         id: 1,
                         picUrl: 'xxxx',
                     }
                 }
                 //...
             ],
             image:[
                 {
                     id:1,
                     picUrl:'xxxx',
                 }
                 //....
             ]
         }
         //...
     ]
 }

//失败

{

　　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/PubliscMsg
请求方式：POST
请求参数：
参数 说明
token 个人令牌
text 发布消息
contentPicUrl 添加图片（数组、对象）
返回值：

//成功

{

　　　　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
返回值：

  //成功
  {
      success: true
      data: [
          {
              id: 1,
              content: 'xxxxx',
              createAt:'2017年7月25日16:46:22',
              user: {
                 id: 1,
                 picUrl: 'xxxx',
             },
             comment: [
                 {
                     id:'2',
                     comment:'xxxx',
                     user: {
                         id: 1,
                         picUrl: 'xxxx',
                     }
                 }
                 //...
             ],
             image:[
                 {
                     id:1,
                     picUrl:'xxxx',
                 }
                 //....
             ]
         }
         //...
     ]
 }

//失败

{

　　　　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:'网络异常！',　

}

十四、忘记密码
请求地址：http://192.168.2.8020/api/ForgetPwd
请求方式：POST
请求参数：
参数 说明
token 个人令牌
email 个人邮箱

返回值：

//成功

{

　　success：true,

　　message:’已为返回密码注意查收’,

}

//失败

{

　　success:false,

　　message:’网络异常，请再次尝试！’

}