diff --git a/doc/README.md b/doc/README.md index 76eef2a..14225df 100644 --- a/doc/README.md +++ b/doc/README.md @@ -12,47 +12,93 @@ http协议全部采用POST请求,请求体和回包都采用json格式。 请求: -| 字段 | 类型 | 备注 | -|------|-----|---------------------------------------| -| name | str | 功能名 | -| data | obj | 协议内容,下文一一列举(如果协议体为空,则没有这个字段,以便减小协议大小) | - -示例: - -```shell -curl http://localhost:8080 \ - -X POST \ - -d '{"name": "login_cs", "data": {"name": "test01"}}' +```jsonc +{ + "name": "login", // 协议名称,不含"_cs"或"_sc" + "data": { // 协议内容,下文一一列举(如果协议体为空,则没有这个字段,以便减小协议大小) + "name": "test01" + } +} ``` 返回: -| 字段 | 类型 | 备注 | -|------|-----|---------------------------------------| -| code | int | 0表示成功 | -| msg | str | 如果code不为0,则为错误信息,否则没有这个字段 | -| data | obj | 协议内容,下文一一列举(如果协议体为空,则没有这个字段,以便减小协议大小) | +```jsonc +{ + "code": 0, + "msg": "ok", // 如果code不为0,则为错误信息,否则没有这个字段 + "data": { // 协议内容,下文一一列举(如果协议体为空,则没有这个字段,以便减小协议大小) + "token": "xxxxx" + } +} +``` ### websocket协议 也采用json格式,只有心跳和推送类两种,客户端to服务器和服务器to客户端的协议格式一致: -| 字段 | 类型 | 备注 | -|------|-----|---------------------------------------| -| name | str | 功能名 | -| data | obj | 协议内容,下文一一列举(如果协议体为空,则没有这个字段,以便减小协议大小) | +```jsonc +{ + "name": "heart_sc", // 协议名称,含"_sc"和"_cs" + "data": { + "now": 12345433342 + } +} +``` + +## 全部协议 + +### 心跳、登录相关 + +**心跳请求** + +协议类型:websocket + +示例: + +```jsonc +{ + "name": "heart_cs", +} +``` + +**心跳返回** + +协议类型:websocket 示例: -```json +```jsonc { "name": "heart_sc", "data": { - "now": 12345433342 + "now": 12345433342 // 服务器当前时间戳,单位毫秒 } } ``` -## 全部协议 +**登录** + +协议类型:http + +请求: -一一列举中。。。 +```jsonc +{ + "name": "login_cs", + "data": { + "name": "test01" + } +} +``` + +返回: + +```jsonc +{ + "code": 0, + "data": { + "room_id": 10 // 房间号,如果为0则表示没有房间 + } +} +```