feat: 增加GM相关接口。详情请看protoc/doc/gm.md文档

zhangqijia
1 parent 0b6d3114
Showing 1 changed file with 50 additions and 0 deletions Show diff stats
doc/gm.md
@@ -0,0 +1,50 @@
+
+## GM
+使用http协议, 使用场景如下
+1. 给客户端提供更改对应的角色数据的接口 (测试时使用)
+2. 提供外放接口,比如支付回调(为了安全也可以再开一个端口, 增加加密协议)
+
+## 接口说明
+### 接口请求地址
+```shell
+ip:port/address
+```
+地址示例, 增加经验接口:
+```shell
+http://192.168.0.206:8881/addexp
+```
+### 返回值 
+```shell
+{"code":0,"message":"success"}
+```
+
+### 共同的请求参数
+| 参数  |   类型  |     是否必须 | 备注 |
+| --- | --- | --- | --- |
+| role_id | string  | Y | 角色id |
+### 共同的错误码说明
+| errorCode 返回值| 描述  |
+| --- | --- | 
+|0|成功|
+|1| protobuf包体解析错误|
+
+下面接口中共同的请求参数和错误码我就不列出来了。
+
+## 增加经验 [/addexp]
+1. 请求方式:POST 提交表单。
+3. 请求参数:(有参数就传)
+
+| 参数  |   类型  |     是否必须 | 备注 |
+| --- | --- | --- | --- |
+| role_id | string  | Y | 角色id |
+| exp | int | Y | 经验数量 |
+
+请求示例：
+```shell
+$ curl --request POST 'http://192.168.0.206:8881/addexp' \
+--data 'role_id=1&exp=111'
+```
+返回结果:
+```shell
+{"code":0}
+```
 \ No newline at end of file