add api useage guide

This commit is contained in:
2015-07-28 23:23:25 +08:00
parent b7321749f0
commit bb8aa8879e
+31 -31
View File
@@ -12,39 +12,39 @@
1 注册 127.0.0.1:3000/api/v1/sign_up
- 参数:
* user[email]
* user[password]
* user[password_confirmation]
- 返回结果
```json
{
"user": {
"id": 10,
"name": "test5",
"email": "test5@qq.com",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbiI6ImU3M2YzYTljMTIxMjVkNDViNjJlNjkxNjQ4MjgyNGVmIn0.Rv_DkYEDWOIhObnTjC_8N8L-BACm8cFCOSqEgSmPUDc"
}
}
```
- 参数:
* user[email]
* user[password]
* user[password_confirmation]
- 返回结果
```json
{
"user": {
"id": 10,
"name": "test5",
"email": "test5@qq.com",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbiI6ImU3M2YzYTljMTIxMjVkNDViNjJlNjkxNjQ4MjgyNGVmIn0.Rv_DkYEDWOIhObnTjC_8N8L-BACm8cFCOSqEgSmPUDc"
}
}
```
2 登录 127.0.0.1:3000/api/v1/sign_in
- 参数:
* user[email]
* user[password]
- 返回结果:
```json
{
"user": {
"id": 3,
"name": null,
"email": "wahyd4@qq.com",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbiI6IjU0MGU4OTU4ODg3ZmI1MGI5YTA5YzI4MjQ2NTZlYTRlIn0.XQBWCNRYVdDvZwuBtafCyOkNpP8FEzwRqk8AhaHlaFc"
}
}
```
- 参数:
* user[email]
* user[password]
- 返回结果:
```json
{
"user": {
"id": 3,
"name": null,
"email": "wahyd4@qq.com",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbiI6IjU0MGU4OTU4ODg3ZmI1MGI5YTA5YzI4MjQ2NTZlYTRlIn0.XQBWCNRYVdDvZwuBtafCyOkNpP8FEzwRqk8AhaHlaFc"
}
}
```
#### 注意
* 注意,API返回结果中的token是利用JWT 技术加密的token,密钥是每个用户的email