diff --git a/doc/account.md b/doc/account.md index f9588e3..9fde6a2 100644 --- a/doc/account.md +++ b/doc/account.md @@ -1,10 +1,22 @@ ## 登录服管理用户账号 +## 接口示例 +接口地址格式如下: +ip:port/version/address +* version: 版本号 +* address 地址 + +示例: +```shell +http://127.0.0.1:8080/v1/register +``` + ### 账号登录 & 注册流程 + 1. 调用注册接口注册账号 2. 使用注册接口返回的uid和游戏服地址,登录游戏服务 -### 注册接口[/v1/register] +### 注册接口[/register] 1. 说明:研发提供的接口必须遵循以下协议 2. 请求方式:POST(JSON) * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】 @@ -40,7 +52,7 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/register' \ * code = 0, 则成功 * code != 0, 则注册失败,message是返回的提示信息 -### 登录接口 [/v1/login] +### 登录接口 [/login] 1. 说明:研发提供的接口必须遵循以下协议 2. 请求方式:POST(JSON) * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】 @@ -76,4 +88,26 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/login' \ * code !=0, 失败, message字段是提示信息 +## 短信接口 [/sms] +1. 说明:研发提供的接口必须遵循以下协议 +2. 请求方式:POST +3. 请求参数:(以参数有就传) + +| 参数 | 类型 | 是否必须 | 备注 | +| --- | --- | --- | --- | +| phone | string | Y |手机号 | + +最后参数组合示例为: +```test +'phone=17683852936' +``` +请求示例: +```shell +$ curl --request POST 'http://192.168.0.206:8080/v1/sms' \ +--data 'phone=17683852936' +``` +返回结果: +```shell +{"code":0,"message":"success"} +``` diff --git a/doc/game.md b/doc/game.md index 0a5abe9..f9e6eda 100644 --- a/doc/game.md +++ b/doc/game.md @@ -17,13 +17,18 @@ | --- | --- | |0|成功| |1| protobuf包体解析错误| -### 登录 +### 登录 LoginReq | errorCode 返回值| 描述 | | --- | --- | |2|角色不存在| -### 创建角色 +### 创建角色 CreateReq | errorCode 返回值| 描述 | | --- | --- | |2|角色不存在| |3|创建角色失败| + +### 阵容变换 GoIntoBattleReq +| errorCode 返回值| 描述 | +| --- | --- | +|2|未登录,角色不在内存中| -- libgit2 0.21.2