Commit 928fa1b8445dcc635a63bc0c13f05336bd4257a9
1 parent
fbe6f3c5
fix: doc reactor
Showing
3 changed files
with
67 additions
and
96 deletions
Show diff stats
doc/game.md
| ... | ... | @@ -19,41 +19,30 @@ |
| 19 | 19 | |-100|打包protobuf数据错误| |
| 20 | 20 | |0|成功| |
| 21 | 21 | |1| protobuf包体解析错误| |
| 22 | -### 登录 LoginReq | |
| 23 | -| errorCode 返回值| 描述 | | |
| 24 | -| --- | --- | | |
| 25 | -|2|角色不存在| | |
| 26 | - | |
| 27 | -### 创建角色 CreateReq | |
| 28 | -| errorCode 返回值| 描述 | | |
| 29 | -| --- | --- | | |
| 30 | -|2|角色不存在| | |
| 31 | -|3|创建角色失败| | |
| 32 | - | |
| 33 | -### 阵容变换 ChangeTeamReq | |
| 34 | - | |
| 35 | -### 装备穿戴/脱下 HeroEquipReferReq | |
| 36 | -请求参数根据`hero_id`来判断穿戴或者脱下。 | |
| 37 | -- 穿戴: hero_id="" | |
| 38 | -- 脱下: hero_id != "" | |
| 39 | - | |
| 40 | -返回值: | |
| 41 | -| errorCode 返回值| 描述 | | |
| 42 | -| --- | --- | | |
| 43 | -|2|装备未获得| | |
| 44 | - | |
| 45 | -### 删除物品 RoleClearItemsReq | |
| 46 | -| errorCode 返回值| 描述 | | |
| 47 | -| --- | --- | | |
| 48 | -|2|删除失败| | |
| 49 | - | |
| 50 | -### 删除装备 EquipmentDelReq | |
| 51 | -| errorCode 返回值| 描述 | | |
| 52 | -| --- | --- | | |
| 53 | -|2|删除失败| | |
| 54 | 22 | |
| 55 | 23 | |
| 56 | -## 通知(服务器主动推送) | |
| 57 | -- 角色信息修改 RoleUpdatePropertyRsp | |
| 58 | -- 物品信息修改 RoleUpdateItemsRsp | |
| 59 | -- 添加装备 EquipmentAddRsp | |
| 24 | +### 文档 & 函数说明 | |
| 25 | +game文档使用godoc生成。查看格式是: | |
| 26 | +```go | |
| 27 | +1 func ChangeTeamRpc | |
| 28 | +2 func ChangeTeamRpc(role *models.RoleModel, msg components.IMessage) (int32, interface{}) | |
| 29 | +3 ChangeTeamRpc 阵容变换 | |
| 30 | +4 | |
| 31 | +5 | |
| 32 | +``` | |
| 33 | +- 第一行: 函数名字 | |
| 34 | +- 第二行: 函数声明 | |
| 35 | +- 第三行: 函数说明 | |
| 36 | +- 第五行: 返回错误码说明 | |
| 37 | + | |
| 38 | +请求参数是把函数最后的三位Rpc替换成Req， 名字是: `pb.ChangeTeamReq{}` | |
| 39 | + | |
| 40 | +### 接口查找 | |
| 41 | +通用地址 | |
| 42 | +```shell | |
| 43 | + 游戏服务ip:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index | |
| 44 | +``` | |
| 45 | +可以把游戏服务ip替换成192.168.0.206 | |
| 46 | +```shell | |
| 47 | +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index | |
| 48 | +``` | ... | ... |
doc/gm.md
| ... | ... | @@ -5,10 +5,43 @@ |
| 5 | 5 | 2. 提供外放接口,比如支付回调(为了安全也可以再开一个端口, 增加加密协议) |
| 6 | 6 | |
| 7 | 7 | ## 接口说明 |
| 8 | -### 简单说明 | |
| 8 | + | |
| 9 | +### 文档 & 函数说明 | |
| 10 | +gm文档使用godoc生成。查看格式是: | |
| 11 | +```go | |
| 12 | +1 func (*GmAction) AddExp | |
| 13 | +2 func (gm *GmAction) AddExp(role *models.RoleModel, params GMParams) | |
| 14 | +3 AddExp 增加经验 | |
| 15 | +4 | |
| 16 | +5 exp: 增加经验数量 | |
| 17 | +``` | |
| 18 | +- 第一行: 函数名字 | |
| 19 | +- 第二行: 函数声明 | |
| 20 | +- 第三行: 函数说明 | |
| 21 | +- 第四行: 空格 | |
| 22 | +- 第五行: 参数1 | |
| 23 | +- 第...行: 参数... | |
| 24 | + | |
| 25 | + | |
| 26 | +### 接口查找 | |
| 27 | +通用地址 | |
| 28 | +```shell | |
| 29 | + 游戏服务ip:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index | |
| 30 | +``` | |
| 31 | +可以把游戏服务ip替换成192.168.0.206 | |
| 32 | +```shell | |
| 33 | +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index | |
| 34 | +``` | |
| 35 | + | |
| 36 | +用上述的增加经验例子，函数名字是AddExp。则接口地址是 | |
| 37 | +``` | |
| 38 | +http://192.168.0.206:8880/addexp?role_id=11exp=1000 | |
| 39 | +``` | |
| 40 | + | |
| 41 | +### 简单示例 | |
| 9 | 42 | 地址示例, 增加经验接口: |
| 10 | 43 | ```shell |
| 11 | -http://192.168.0.206:8880/addexp | |
| 44 | +$ curl -i 'http://192.168.0.206:8880/addexp?role_id=150140287594270720&exp=111' | |
| 12 | 45 | ``` |
| 13 | 46 | 返回值 |
| 14 | 47 | ```shell |
| ... | ... | @@ -30,65 +63,11 @@ http://192.168.0.206:8880/addexp |
| 30 | 63 | |-102|角色id未填写| |
| 31 | 64 | |-103|角色不存在| |
| 32 | 65 | |
| 33 | -下面接口中共同的请求参数和错误码省略。 需要保证参数先后顺序。 | |
| 34 | - | |
| 35 | -## 增加经验 [/addexp] | |
| 36 | -1. 请求方式: GET。 | |
| 37 | -3. 请求参数:(有参数就传) | |
| 38 | - | |
| 39 | -| 参数 | 类型 | 是否必须 | 备注 | | |
| 40 | -| --- | --- | --- | --- | | |
| 41 | -| exp | int | Y | 经验数量 | | |
| 42 | - | |
| 43 | -请求示例： | |
| 44 | -```shell | |
| 45 | -$ curl -i 'http://192.168.0.206:8880/addexp?role_id=150140287594270720&exp=111' | |
| 46 | -``` | |
| 47 | -返回结果: | |
| 48 | -```shell | |
| 49 | -{"code":0} | |
| 50 | -``` | |
| 51 | - | |
| 52 | - | |
| 53 | -## 添加装备 [/addequip] | |
| 54 | -1. 请求方式: GET。 | |
| 55 | -3. 请求参数:(有参数就传) | |
| 56 | - | |
| 57 | -| 参数 | 类型 | 是否必须 | 备注 | | |
| 58 | -| --- | --- | --- | --- | | |
| 59 | -| id | int | Y | 装备在配置表中的id | | |
| 60 | - | |
| 61 | -请求示例： | |
| 62 | -```shell | |
| 63 | -$ curl -i 'http://192.168.0.206:8880/addequip?role_id=1000002&id=0' | |
| 64 | -``` | |
| 65 | -返回结果: | |
| 66 | -```shell | |
| 67 | -{"code":0} | |
| 68 | -``` | |
| 66 | +下面接口中共同的请求参数和错误码省略。 | |
| 69 | 67 | |
| 70 | -## 删除装备 [/delequip] | |
| 71 | -| 参数 | 类型 | 是否必须 | 备注 | | |
| 72 | -| --- | --- | --- | --- | | |
| 73 | -| id | string | Y | 服务器上的装备id | | |
| 74 | 68 | |
| 75 | -请求示例： | |
| 76 | -```shell | |
| 77 | -$ curl -i 'http://192.168.0.206:8880/delequip?role_id=1000002&id=0' | |
| 78 | -``` | |
| 79 | -## 添加物品 [/additem] | |
| 80 | -| 参数 | 类型 | 是否必须 | 备注 | | |
| 81 | -| --- | --- | --- | --- | | |
| 82 | -| id | string | Y | 物品id | | |
| 83 | -| count | int | Y | 需要添加物品数量 | | |
| 84 | 69 | |
| 85 | -## 删除物品 [/delitem] | |
| 86 | -| 参数 | 类型 | 是否必须 | 备注 | | |
| 87 | -| --- | --- | --- | --- | | |
| 88 | -| id | string | Y | 物品id | | |
| 89 | -| count | int | Y | 需要删除的物品数量 | | |
| 70 | +## 接口地址 | |
| 71 | +如果下面地址不通，则把ip替换成其他游戏服务的ip: | |
| 90 | 72 | |
| 91 | -请求示例： | |
| 92 | -```shell | |
| 93 | -$ curl -i 'http://192.168.0.206:8880/delitem?role_id=1000002&id=1&count=1' | |
| 94 | -``` | |
| 95 | 73 | \ No newline at end of file |
| 74 | +192.168.0.206:8980/pkg/pro2d/cmd/gameserver/action/#pkg-index | ... | ... |