Commit 432c66d9981fa1f6423f3e5aa27543a98ce8895c
1 parent
4d72246e
解决循环引用的问题
Showing
1 changed file
with
33 additions
and
2 deletions
Show diff stats
doc/login.md
| @@ -4,7 +4,7 @@ | @@ -4,7 +4,7 @@ | ||
| 4 | 1. 调用注册接口注册账号 | 4 | 1. 调用注册接口注册账号 |
| 5 | 2. 使用注册接口返回的uid和游戏服地址，登录游戏服务 | 5 | 2. 使用注册接口返回的uid和游戏服地址，登录游戏服务 |
| 6 | 6 | ||
| 7 | -### 注册接口 | 7 | +### 注册接口[/v1/register] |
| 8 | 1. 说明:研发提供的接口必须遵循以下协议 | 8 | 1. 说明:研发提供的接口必须遵循以下协议 |
| 9 | 2. 请求方式:POST(JSON) | 9 | 2. 请求方式:POST(JSON) |
| 10 | * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】 | 10 | * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】 |
| @@ -38,7 +38,38 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/register' \ | @@ -38,7 +38,38 @@ $ curl --request POST 'http://192.168.0.206:8080/v1/register' \ | ||
| 38 | {"code":0 ,"data":{"phone":"", "uid":"","password":""}} | 38 | {"code":0 ,"data":{"phone":"", "uid":"","password":""}} |
| 39 | ``` | 39 | ``` |
| 40 | 40 | ||
| 41 | -### 创建token接口 | 41 | +### 登录接口 [/v1/login] |
| 42 | +1. 说明:研发提供的接口必须遵循以下协议 | ||
| 43 | +2. 请求方式:POST(JSON) | ||
| 44 | + * 请求参数需要拼接为json,请求体是data-raw, 详情参考【请求参数】 | ||
| 45 | +3. 请求参数:(以参数有就传) | ||
| 46 | + | ||
| 47 | +| 参数 | 类型 | 是否必须 | 备注 | | ||
| 48 | +| --- | --- | --- | --- | | ||
| 49 | +| phone | string | Y |手机号 | | ||
| 50 | +| password | string | Y | 密码 | | ||
| 51 | + | ||
| 52 | +最后参数组合示例为: | ||
| 53 | +```json | ||
| 54 | +{ | ||
| 55 | + "phone":"17683852936", | ||
| 56 | + "password":"123456" | ||
| 57 | +} | ||
| 58 | +``` | ||
| 59 | + | ||
| 60 | +请求示例： | ||
| 61 | +```shell | ||
| 62 | +$ curl --request POST 'http://192.168.0.206:8080/v1/login' \ | ||
| 63 | +--header 'Content-Type: application/json' \ | ||
| 64 | +--data '{ | ||
| 65 | + "phone":"17683852936", | ||
| 66 | + "password":"123456" | ||
| 67 | +}' | ||
| 68 | +``` | ||
| 69 | +返回结果: | ||
| 70 | +```shell | ||
| 71 | +{"code":0 ,"data":{"phone":"", "uid":"","password":""}} | ||
| 72 | +``` | ||
| 42 | 73 | ||
| 43 | 74 | ||
| 44 | 75 |