基本的网络地址
+ 分支节点
http://127.0.0.1:8080/chat
为 基本的网络地址
/login
为 分支节点
http://127.0.0.1:8080/chat/login
组成完整的 URL
当前统一的基本网络地址
为 http://127.0.0.1:8080/ChatServer
POST
GET
PUT
键值对(key value形式)
键值对(key value形式)
统一的返回码为: 200
(注:只要访问服务器成功,一律返回200)Json
成功
{flag:true, data:...}
成功的标记为 flag 为 true
根据具体的请求,如果需要返回值 data节点
包含的是 返回结果
不需要需要返回值 ,则没有data节点
失败
{flag:false, errorCode:1, errorString:"错误原因"}
失败的标记为 flag 为 false
flag 为 false时,必然返回 errorCode
和errorString
节点
errorCode
说明了错误编码
errorString
说明错误原因/login
POST
成功
{ "flag": true, "data": { "account": "zhangsan", "name": "张三", "sex": 1, "icon": "/a/b/zhangsan.png", "sign": "我的个性签名", "area": "深圳", "token": "5904c7ae-3e75-48c8-bbee-ad094533a422" } } 失败
errorCode | errorString ---------- | -------------- 100 | 用户密码错误 101 | 用户不存在/register
POST
成功
{ "flag": true, "data": { "account": "zhangsan", "name": "张三", "sex": 1, "icon": "/a/b/zhangsan.png", "sign": "我的个性签名", "area": "深圳", "token": "5904c7ae-3e75-48c8-bbee-ad094533a422" } } 失败
errorCode | errorString ---------- | -------------- 150 | 用户已经存在/user/search
POST
成功
{ "flag": true, "data": { "account": "zhangsan", "name": "张三", "icon": "/a/b/zhangsan.png", "sign": "我的个性签名", "area": "深圳" } } 失败
errorCode | errorString ---------- | -------------- 200 | 用户不存在/friend/accept
POST
成功
{ "flag": true } 失败
{ "flag": false } /friend/list
POST
成功
{ "flag": true } 失败
{ "flag": false } /user/nameChange
POST
成功
{ "flag": true } 失败
{ "flag": false } json
请求
和 响应
client --> server
: 发送消息
server --> client
: 推送消息请求
: client 发送消息到 server
响应
: server 响应 client 的这次消息请求
两个过程 都完成 才算 当前消息发送成功
请求
: server 发送消息到 client
响应
: client 响应 server 的这次消息请求
两个过程 都完成 才算 当前消息发送成功
请求部分
:
{ "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2", "type": "request", "action": "text" }
响应部分
:
{ "sequence": "9f4c696e-9ab5-46cf-959c-b1e2e35200d2", "type": "response", "flag": "true" }
sequece
: 标记 请求 和 响应,用来表明 响应
是 针对 哪次 请求
的
type
: 用来标记 是 请求
还是 响应
action
: 请求发送方 的 发送类型,由具体请求 决定取值。auth
{"sequence":"1","type":"request","action":"auth","sender":"iphone1","token":"0dce6f76ac1a29d276c0c6dabe60519c"}
invitation
text
invitation
reinvitation
text
nameChange