创新实训——接口设计

功能说明

用户注册

Request

方向

客户端——>服务器

传输协议

http  get

格式

/user/register.jsp? {PARAM}

参数

userId用户账号，1~11位数字

userPwd 用户密码 1~20位数字、英文、字符，非中文

例子

/ user/register.jsp?userId=123&userPwd=111

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

}

参数说明

status：int类型，注册后返回结果，0表示注册失败，1表示注册成功

功能说明

用户登录时验证用户账号，密码

Request

方向

客户端——>服务器

传输协议

http  get

格式

/user/login.jsp?{PARAM}

参数

userId 用户账号，1~11位数字

userPwd 用户密码，1~20位数字、英文、字符，非中文

例子

/user/login.jsp?userId=123&userPwd=111

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:1

}

参数说明

status：int类型，登陆验证后返回结果，0表示登陆失败，1表示登陆成功

功能说明

提交用户的个人信息

Request

方向

客户端——>服务器

传输协议

http  get

格式

/user/setInfo?{PARAM}      注意没有”jsp”

参数

userId 用户账号，1~11位数字

name 用户名，0~40位，中文0~20位

age   年龄，0~3位数字

sex   性别，String，0~10位，中文0~5位

head  用户头像URL，String类型

参数说明

必须包含参数userId，其他参数不必全部都有

例子

/user/setInfo?userid=123& name=”hahaha”

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:1

}

参数说明

status：int类型，返回结果，0表示提交失败，1表示提交成功

功能说明

用户请求个人信息

Request

方向

客户端——>服务器

传输协议

http  get

格式

user/getInfo

参数

userId 用户账号

例子

/user/ getInfo?userId=17812341234

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0,

   “userInfo”:{

        “userId”: 123,

“name”:”xxx”,

“age”:23,

“sex”:”null”,

“head”:”http://www.baidu.com”

}

}

参数说明

status：int类型，0为失败，1为成功

功能说明

提交图片URL，后台获取图片做图像处理，返回新的URL，区分处理类型

Request

方向

客户端——>服务器

传输协议

http  get

格式

img/imgProcess?{PARAMS}

参数

url，图片在七牛云的url，String

type，处理类型，int

例子

img/imgProcess?url=”http://www.baidu.com”&type=1

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

   “url”:”http://www.google.com”

 }

参数说明

status：int类型，0为失败，1为成功

url：处理后新的url

功能说明

提交图片URL，后台获取图片做图像处理，返回新的URL，区分处理类型

发帖之后需要请求刷新才会显示在朋友圈里

Request

方向

客户端——>服务器

传输协议

http  post

格式

moment/sendMoment?{PARAMS}

参数

userId 用户id，int

text 内容，String

imgs 所有图片的url，（json），String，后台不做处理

例子

moment/sendMoment?

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

}

参数说明

status：int类型，0为失败，1为成功

功能说明

获取朋友圈的帖子，分页获取，每页五个帖子

Request

方向

客户端——>服务器

传输协议

http  get

格式

moment/getMoment?{PARAMS}

参数

userId 用户id，int[CX1] 

mid 当前展示的最后一个说说的id，初始加载时是-1[CX2] 

例子

moment/getMoment?userId=111&page=1

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{

    "status": 1,

    "moments": [

        {

            "momentId": 2,

            "userId": 111,

            "time": "2018-08-08 22:19:05.0",

            "text": "???",

            "imgs": "[\"http://pcqi1922c.bkt.clouddn.com/FqKRdNSWiPlQ2u5K4BIjM59o2IV0\"]",

            "comments": ""

        },

        {

            "momentId": 1,

            "userId": 111,

            "time": "2018-08-04 18:17:46.0",

            "text": "å??å??",

            "imgs": "[\"http://pcqi1922c.bkt.clouddn.com/FqKRdNSWiPlQ2u5K4BIjM59o2IV0\"]"

        }

    ]

}

参数说明

status：int类型，0为失败，1为成功

monemts按照时间、id从大到小下发

功能说明

删除自己的帖子

Request

方向

客户端——>服务器

传输协议

http  get

格式

moment/deleteMoment?{PARAMS}

参数

momentId  说说id，int

userId 用户id，只能删除自己的帖子

例子

moment/ deleteMoment?momentId=1&userId=111

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

}

参数说明

status：int类型，0为失败，1为成功

功能说明

目前只支持添加评论，不能删除评论

Request

方向

客户端——>服务器

传输协议

http  get

格式

moment/coment?{PARAMS}

参数

momentId  说说id，int

text 评论内容，String

userId 用户id，int

type 事件类型，int，0为添加评论，1为删除评论（目前不支持）

例子

moment/comment?momentId=1&text=”哈哈哈”&userId=111&type=0

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

}

参数说明

status：int类型，0为失败，1为成功

功能说明

支持点赞和取消点赞

Request

方向

客户端——>服务器

传输协议

http  get

格式

moment/like?{PARAMS}

参数

momentId  说说id，int

userId 用户id，int

type 事件类型，int，0为点赞，1为取消点赞

例子

moment/comment?momentId=1 &userId=111&type=0

Response

方向

服务器——>客户端

传输协议

http + json

数据格式

{  “status”:0

}

参数说明

status：int类型，0为失败，1为成功