zhangqijia / Pro2dProtoBuffers

Commit c1d210bd2ef2b9ce1a23c747a814b6ee308f951d

Authored by zhangqijia
1 parent 00391250

feat: 增加短信接口，增加上阵协议

Showing 2 changed files with 43 additions and 4 deletions   Show diff stats
Inline Side-by-side
doc/account.md
  Show/Hide comments   View file @c1d210b
1 1  
2 2 ## 登录服管理用户账号
  3 +## 接口示例
  4 +接口地址格式如下：
  5 +ip:port/version/address
  6 +* version: 版本号
  7 +* address 地址
  8 +
  9 +示例:
  10 +```shell
  11 +http://127.0.0.1:8080/v1/register
  12 +```
  13 +
3 14 ### 账号登录 & 注册流程
  15 +
4 16 1. 调用注册接口注册账号
5 17 2. 使用注册接口返回的uid和游戏服地址，登录游戏服务
6 18  
7   -### 注册接口[/v1/register]
  19 +### 注册接口[/register]
8 20 1. 说明:研发提供的接口必须遵循以下协议
9 21 2. 请求方式:POST(JSON)
10 22 * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】
... ... @@ -40,7 +52,7 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/register' \
40 52 * code = 0, 则成功
41 53 * code != 0, 则注册失败，message是返回的提示信息
42 54  
43   -### 登录接口 [/v1/login]
  55 +### 登录接口 [/login]
44 56 1. 说明:研发提供的接口必须遵循以下协议
45 57 2. 请求方式:POST(JSON)
46 58 * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】
... ... @@ -76,4 +88,26 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/login' \
76 88 * code !=0, 失败， message字段是提示信息
77 89  
78 90  
  91 +## 短信接口 [/sms]
  92 +1. 说明:研发提供的接口必须遵循以下协议
  93 +2. 请求方式:POST
  94 +3. 请求参数:(以参数有就传)
  95 +
  96 +| 参数 | 类型 | 是否必须 | 备注 |
  97 +| --- | --- | --- | --- |
  98 +| phone | string | Y |手机号 |
  99 +
  100 +最后参数组合示例为:
  101 +```test
  102 +'phone=17683852936'
  103 +```
79 104  
  105 +请求示例：
  106 +```shell
  107 +$ curl --request POST 'http://192.168.0.206:8080/v1/sms' \
  108 +--data 'phone=17683852936'
  109 +```
  110 +返回结果:
  111 +```shell
  112 +{"code":0,"message":"success"}
  113 +```
... ...
doc/game.md
  Show/Hide comments   View file @c1d210b
... ... @@ -17,13 +17,18 @@
17 17 | --- | --- |
18 18 |0|成功|
19 19 |1| protobuf包体解析错误|
20   -### 登录
  20 +### 登录 LoginReq
21 21 | errorCode 返回值| 描述 |
22 22 | --- | --- |
23 23 |2|角色不存在|
24 24  
25   -### 创建角色
  25 +### 创建角色 CreateReq
26 26 | errorCode 返回值| 描述 |
27 27 | --- | --- |
28 28 |2|角色不存在|
29 29 |3|创建角色失败|
  30 +
  31 +### 阵容变换 GoIntoBattleReq
  32 +| errorCode 返回值| 描述 |
  33 +| --- | --- |
  34 +|2|未登录，角色不在内存中|
... ...