API说明

2019-03-12 10:27:58
Catouse
1144
最后编辑:朱宝鑫 于 2019-06-27 08:29:16

名词约定

client:喧喧客户端    xxd:GO 聊天服务器    xxb:后台然之服务器

1.API数据格式

常见的请求对象格式

{
  userID, // 用户id,xxd → xxb 非登录时必须
  module, // 模块名称,必须
  method, // 方法名称,必须
  test,   // 可选参数,bool,默认为false。
  params, // 参数对象,可选
  data    // 请求数据,可选,与params配合使用,通常data传输是对象
}

常见的响应数据格式

{
  module,  // 模块名称,必须
  method,  // 方法名称,必须
  users[], // 该数据响应给哪些用户,users为空表示所有在线用户
  params,  // 参数对象,可选
  result:, // 响应状态,可为"success"(成功), "fail"(失败), "denied"(拒绝,需要登录),
  message:,// 消息,可选,当result不为success时,使用此字段来解释原因
  data     // 数据 
}

2.xxd启动

xxd启动时会向xxb发送一条请求,xxb收到请求将所有用户状态重置为offline。

请求

方向:xxd → xxb
{
  module: "chat",
  method: "serverStart"
}

响应

方向:xxb → xxd
HTTP Status Code


发表评论
评论通过审核后显示。