Commit c80a4b2485a235cb0459f9cd9ab0979c6a971168
1 parent
0b6d3114
feat: 增加GM相关接口。详情请看protoc/doc/gm.md文档
Showing
1 changed file
with
50 additions
and
0 deletions
Show diff stats
| @@ -0,0 +1,50 @@ | @@ -0,0 +1,50 @@ | ||
| 1 | + | ||
| 2 | +## GM | ||
| 3 | +使用http协议, 使用场景如下 | ||
| 4 | +1. 给客户端提供更改对应的角色数据的接口 (测试时使用) | ||
| 5 | +2. 提供外放接口,比如支付回调(为了安全也可以再开一个端口, 增加加密协议) | ||
| 6 | + | ||
| 7 | +## 接口说明 | ||
| 8 | +### 接口请求地址 | ||
| 9 | +```shell | ||
| 10 | +ip:port/address | ||
| 11 | +``` | ||
| 12 | +地址示例, 增加经验接口: | ||
| 13 | +```shell | ||
| 14 | +http://192.168.0.206:8881/addexp | ||
| 15 | +``` | ||
| 16 | +### 返回值 | ||
| 17 | +```shell | ||
| 18 | +{"code":0,"message":"success"} | ||
| 19 | +``` | ||
| 20 | + | ||
| 21 | +### 共同的请求参数 | ||
| 22 | +| 参数 | 类型 | 是否必须 | 备注 | | ||
| 23 | +| --- | --- | --- | --- | | ||
| 24 | +| role_id | string | Y | 角色id | | ||
| 25 | +### 共同的错误码说明 | ||
| 26 | +| errorCode 返回值| 描述 | | ||
| 27 | +| --- | --- | | ||
| 28 | +|0|成功| | ||
| 29 | +|1| protobuf包体解析错误| | ||
| 30 | + | ||
| 31 | +下面接口中共同的请求参数和错误码我就不列出来了。 | ||
| 32 | + | ||
| 33 | +## 增加经验 [/addexp] | ||
| 34 | +1. 请求方式:POST 提交表单。 | ||
| 35 | +3. 请求参数:(有参数就传) | ||
| 36 | + | ||
| 37 | +| 参数 | 类型 | 是否必须 | 备注 | | ||
| 38 | +| --- | --- | --- | --- | | ||
| 39 | +| role_id | string | Y | 角色id | | ||
| 40 | +| exp | int | Y | 经验数量 | | ||
| 41 | + | ||
| 42 | +请求示例： | ||
| 43 | +```shell | ||
| 44 | +$ curl --request POST 'http://192.168.0.206:8881/addexp' \ | ||
| 45 | +--data 'role_id=1&exp=111' | ||
| 46 | +``` | ||
| 47 | +返回结果: | ||
| 48 | +```shell | ||
| 49 | +{"code":0} | ||
| 50 | +``` | ||
| 0 | \ No newline at end of file | 51 | \ No newline at end of file |