接口约定
- 使用https
- restful风格
- 用户端：https://{域名}/api/{接口版本号}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
- 管理端：https://{域名}/admin/api/{接口版本号}/{resource}/{resource_id}/{sub_resource}/{sub_resource_id}/{action}?{query_string}
- 测试环境域名babieta.xivan.cn
- 正式环境域名待定
- 公共参数放在header，如userid,session_key,unionid,version等
- resource: comments
接口
POST /comments/<busi_type>/<busi_id>
| name | cname | type | Description |
|---|---|---|---|
| 用途 | 评论 | ||
| 版本号 | v1.0 | ||
| busi_type | 业务类型 | string | soak(浸泡训练) |
| busi_id | 业务id | string |
请求数据：
body 参数/可选参数
| name | cname | type | Description |
|---|---|---|---|
| text | 评论内容 | string |
例
curl -i -XPOST "https://babieta.xivan.cn/api/v1.0/comments/soak/1" -H "openid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e" -d '{"text":"内容"}'
wx.request({
"url":"https://babieta.xivan.cn/api/v1.0/comments/soak/1",
"method":"POST",
"success": res =>{
console.log(res)
},
"data":{text:'内容'},
"dataType":"json",
"header": { "content-type":"application/json",
"openid": "oslC94mGqAAEz6iWhKhL9dEY5l3o", "token":"25e8ba0469c6f1c0c6dcd4fe952b8e4e"},
"complete": res => {
console.log(res)
}
})
返回数据：
| name | cname | type | Description |
|---|---|---|---|
| code | int | 返回码 0成功 非0失败 | |
| msg | string | 错误信息 |
例
{
"msg": "",
"code": 0,
}
GET /comments/<busi_type>/<busi_id>
| name | cname | type | Description |
|---|---|---|---|
| 用途 | 评论 | ||
| 版本号 | v1.0 | ||
| busi_type | 业务类型 | string | soak(浸泡训练) |
| busi_id | 业务id | string |
请求数据：
query string 参数/可选参数
| name | cname | type | Description |
|---|---|---|---|
| cursor | 游标，用于分页 | string | 取上一次页面的cursor透传,默认不传或空 |
| limit | 数量 | int | 默认10 |
例
curl -i "https://babieta.xivan.cn/api/v1.0/comment/soak/1?limit=10&cursor=10" -H "openid:oslC94mGqAAEz6iWhKhL9dEY5l3o" -H "token:25e8ba0469c6f1c0c6dcd4fe952b8e4e"
wx.request({
"url":"https://babieta.xivan.cn/api/v1.0/comment/soak/1?limit=10&cursor=10",
"method":"GET",
"success": res =>{
console.log(res)
},
"data":{busi_type:'soak', busi_id:1, limit:10, last_id='1123'},
"dataType":"json",
"header": { "content-type":"application/x-www-form-urlencoded",
"openid": "oslC94mGqAAEz6iWhKhL9dEY5l3o", "token":"25e8ba0469c6f1c0c6dcd4fe952b8e4e"},
"complete": res => {
console.log(res)
}
})
返回数据：
| name | cname | type | Description |
|---|---|---|---|
| code | int | 返回码 0成功 非0失败 | |
| msg | string | 错误信息 |
例
{
"msg": "",
"code": 0,
"list": [{
"id":"11", //评论id
"content":"abc", //评论内容
"comment_ts":1111111, //评论时间
"comment_user": { //评论人信息
"nickname":"aa" , //昵称
"avatar_url":"http://111.jpg", //头像
"userid":"1232", //id
"level":10 //级别
},
"praise_count":10 //点赞数,
"praise_flag":1 //点赞状态 1 已点赞 0 未点赞
},...],
"count":123,//评论类型
"cursor":"111" //透传id
}
