Update README.md

dev_forge
Jasder 5 years ago
parent 17547cf120
commit 3a04de4371

@ -1039,22 +1039,17 @@ http://localhost:3000/api/18816895620/mirror_demo/commits | jq
### 点赞 ### 点赞
``` ```
POST /api/praise_tread/like POST /api/projects/:id/praise_tread/like
``` ```
*示例* *示例*
``` ```
curl -X POST \ curl -X POST http://localhost:3000/api/projects/3263/praise_tread/like | jq
-d 'object_id=1' \
-d 'object_type=project' \
http://localhost:3000/api/praise_tread/like | jq
``` ```
*请求参数说明:* *请求参数说明:*
|参数名|必选|类型|说明| |参数名|必选|类型|说明|
-|-|-|- -|-|-|-
|object_id |是 |int |项目id | |id |是 |int |项目id |
|object_type |否 |string | 点赞类型默认为project|
*返回参数说明:* *返回参数说明:*
@ -1067,28 +1062,24 @@ http://localhost:3000/api/praise_tread/like | jq
``` ```
{ {
"status": 0, "status": 0,
"message": "响应成功" "message": "success"
} }
``` ```
--- ---
### 取消点赞 ### 取消点赞
``` ```
DELETE /api/praise_tread/unlike DELETE /api/projects/:id/praise_tread/unlike
``` ```
*示例* *示例*
``` ```
curl -X DELETE \ curl -X DELETE http://localhost:3000/api/projects/3263/praise_tread/unlike | jq
-d 'object_id=1' \
-d 'object_type=project' \
http://localhost:3000/api/praise_tread/unlike | jq
``` ```
*请求参数说明:* *请求参数说明:*
|参数名|必选|类型|说明| |参数名|必选|类型|说明|
-|-|-|- -|-|-|-
|object_id |是 |string |点赞对象的唯一标识如项目的identifier字段 | |id |是 |string |项目id |
|object_type |是 |string | 点赞类型默认为project|
*返回参数说明:* *返回参数说明:*
@ -1102,7 +1093,7 @@ http://localhost:3000/api/praise_tread/unlike | jq
``` ```
{ {
"status": 0, "status": 0,
"message": "响应成功" "message": "success"
} }
``` ```
--- ---
@ -1114,30 +1105,42 @@ GET /api/projects/:id/praise_tread
*示例* *示例*
``` ```
curl -X GET \ curl -X GET \
-d 'object_id=1' \ -d "page=1" \
-d 'object_type=project' \ -d "limit=5" \
http://localhost:3000/api/projects/mirror_demo/praise_tread | jq http://localhost:3000/api/projects/3263/praise_tread | jq
``` ```
*请求参数说明:* *请求参数说明:*
|参数名|必选|类型|说明| |参数名|必选|类型|说明|
-|-|-|- -|-|-|-
|object_id |是 |int |项目id | |id |是|int |项目id |
|object_type |否 |string | 点赞类型默认为project| |page |否|string |页数,第几页 |
|limit |否|string |每页多少条数据默认15条 |
*返回参数说明:* *返回参数说明:*
|参数名|类型|说明| |参数名|类型|说明|
-|-|- -|-|-
|status |int|0:点赞成功,-1:操作失败2:表示已经点过赞了| |total_count |int|总条数|
|praises |array|关注数据|
|-- name |string|用户名称|
|-- login |string|用户标识/登录名(login)|
|-- image_url |string|用户头像|
返回值 返回值
``` ```
{ {
"status": 0, "total_count": 1,
"message": "响应成功" "praises": [
{
"name": "18816895620",
"login": "18816895620",
"image_url": "avatars/User/b"
}
]
} }
``` ```
--- ---

Loading…
Cancel
Save