Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by 张帅
Commit 93d4a5155de25273ed8e87da0b81f81e62918d5a 1 parent 16d4b1a7

接口调整

Inline Side-by-side
Showing 2 changed files with 64 additions and 211 deletions
... ... @@ -22,160 +22,39 @@ code为200即为成功。
{
"code": 200,
"data": {
"detailList": [
"detailList": [
{
"articleId": 16,
"articleProductType": 1, //文章下商品的来源 ： 1 有货商品 2 ufo商品
"articleId": 82,
"articleProductType": 2,
"articleType": 1,
"authorHeadIco": "http://head.static.yhbimg.com/yhb-head/2018/10/19/14/01c349dfd4e467b7ca208e355eeb921122.jpg?imageView2/{mode}/w/{width}/h/{height}",
"authorName": "admire102",
"authorName": "羡慕丶",
"authorType": 1,
"authorUid": 500031572,
"blockList": [ //文章内容列表，templateKey 有image和text两种 对应图片和文本内容
"blockList": [
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"articleId": 82,
"contentData": "http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg?imageView2/{mode}/w/{width}/h/{height}",
"createTime": 1548671254,
"height": "276",
"orderBy": 0,
"templateKey": "image"
"templateKey": "image",
"width": "640"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"articleId": 82,
"contentData": "http://img10.static.yhbimg.com/yhb-img01/2015/05/20/20/017f40fe5be35c9e1412cd8e2164c87e83.jpg?imageView2/{mode}/w/{width}/h/{height}",
"createTime": 1548671255,
"height": "750",
"orderBy": 1,
"templateKey": "image"
"templateKey": "image",
"width": "750"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"articleId": 82,
"contentData": "文本文",
"createTime": 1548671255,
"orderBy": 2,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 3,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 4,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 5,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 6,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 7,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 8,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 9,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 10,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 11,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg\"}\"}",
"createTime": 1547703673,
"orderBy": 12,
"templateKey": "image"
},
{
"articleId": 16,
"contentData": "{\"template_name\":\"text\",\"data\":\"{\"text\":\"测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容\"}\"}",
"createTime": 1547703673,
"orderBy": 13,
"templateKey": "text"
}
],
"comments": [], //评论列表
"favoriteCount": 0,
"hasAttention": "N", //是否已关注作者
"hasFavor": "N", //是否已经收藏
"hasPraise": "N", //是否已经点赞
"praiseCount": 0, //点赞总数
"productList": [ //文章关联商品skn列表
{
"id": 30,
"orderBy": 0,
"productSkn": 51068726，
"productType": 1
},
{
"id": 32,
"orderBy": 1,
"productSkn": 51068724,
"productType": 1
}
],
"publishTime": 1547703673,
"publishTimeStr": "2019-01-17 13:41:13",
"topicName": "123" //话题名称
"topicId":12 //话题id
},
{
"articleId": 50,
"articleType": 2,
"authorHeadIco": "http://img11.static.yhbimg.com/author/2017/06/08/10/014483873c531a0b790a8711a0c8d9b7dc.jpg",
"authorName": "周尾生",
"authorType": 3,
"authorUid": 8168300,
"blockList": [
{
"articleId": 50,
"contentData": "{\"template_name\":\"image\",\"data\":\"{\"src\":\"http://img10.static.yhbimg.com/article/2017/12/12/14/01b4507eb5991152542a9893dac355202e.jpg\"}\"}",
"createTime": 1548300308,
"orderBy": 0,
"templateKey": "image"
},
{
"articleId": 50,
"contentData": "{\"template_name\":\"text\",\"data\":\"{\"text\":\"测试\"}\"}",
"createTime": 1548300308,
"orderBy": 1,
"templateKey": "text"
}
],
... ... @@ -186,11 +65,20 @@ code为200即为成功。
"hasFavor": "N",
"hasPraise": "N",
"praiseCount": 0,
"publishTime": 1548300308,
"publishTimeStr": "2019-01-24 11:25:08",
"relateId": 69078 //逛文章id 请求/guang接口的时候 article_id为 列表接口返回的relateId
"productList": [
{
"id": 84,
"orderBy": 0,
"productSkn": 10001061,
"productType": 2
}
],
"publishTime": 1548671254,
"publishTimeStr": "2019-01-28 18:27:34",
"topicId": 33,
"topicName": "123"
}
],
],
"pageSize": 5,
"totalCount": 5
... ...
... ... @@ -23,34 +23,40 @@ code为200即为成功。
"total":1,
"totalPage":1,
"list": [
{
"articleId": 20, //文章id
"articleType": 1, //文章类型，1用户发布、2 逛文章
"authorHeadIco": "http://head.static.yhbimg.com/yhb-head/2018/10/19/14/01c349dfd4e467b7ca208e355eeb921122.jpg?imageView2/{mode}/w/{width}/h/{height}", //作者头像
"authorName": "admire102", //作者昵称
{
"articleId": 82, //文章id
"articleType": 1,//文章类型，1用户发布、2 逛文章
"authorHeadIco": "http://head.static.yhbimg.com/yhb-head/2018/10/19/14/01c349dfd4e467b7ca208e355eeb921122.jpg?imageView2/{mode}/w/{width}/h/{height}",
"authorName": "羡慕丶",
"authorType": 1, //进入个人主页的视角。 1.作者本人 2.非作者 3.作者是平台小编
"authorUid": 500031572, //作者uid
"content": "页面发布", //文字内容
"coverImage": "http://flv01.static.yhbimg.com/activity/2019/01/17/15/03cee78e10e88ceffb07ec6d8121d2941b.jpg", //封面图
"favoriteCount": 0, //收藏数
"hasFavor": "N", //是否收藏
"publishTime": 1547710922, //发布时间
"publishTimeStr": "2019-01-17 15:42:02" //发布时间
}，
{
"articleId": 56,
"articleType": 2, //文章类型，1用户发布、2 逛文章 逛文章进详情和用户内容不一样
"authorHeadIco": "http://img11.static.yhbimg.com/author/2017/06/08/10/014483873c531a0b790a8711a0c8d9b7dc.jpg",
"authorName": "周尾生",
"authorType": 3,
"authorUid": 8168300,
"content": "测试",
"coverImage": "http://img12.static.yhbimg.com/article/2017/12/11/16/02c0768b79e79227292e71eee86783f49c.jpg",
"authorUid": 500031572,
"content": "文本文",//文字内容
"coverImage": "http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg?imageView2/{mode}/w/{width}/h/{height}", //封面图
"favoriteCount": 0, //收藏数
"hasFavor": "N", //是否收藏
"imageHeight": "276", //封面图高度
"imageWidth": "640", //封面图宽度
"isTop": 1, //是否置顶
"publishTime": 1548671254,
"publishTimeStr": "2019-01-28 18:27:34"
},
{
"articleId": 86,
"articleType": 1,
"authorHeadIco": "http://head.static.yhbimg.com/yhb-head/2018/10/19/14/01c349dfd4e467b7ca208e355eeb921122.jpg?imageView2/{mode}/w/{width}/h/{height}",
"authorName": "羡慕丶",
"authorType": 1,
"authorUid": 500031572,
"content": "第2篇",
"coverImage": "http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg?imageView2/{mode}/w/{width}/h/{height}",
"favoriteCount": 0,
"hasFavor": "N",
"publishTime": 1548300444,
"publishTimeStr": "2019-01-24 11:27:24",
"relateId": 69076 //逛文章id 请求guang/接口的时候 article_id为 列表接口返回的relateId
"imageHeight": "276",
"imageWidth": "640",
"isTop": 0,
"publishTime": 1548673065,
"publishTimeStr": "2019-01-28 18:57:45"
}
],
"pageNo": 1,
... ... @@ -64,48 +70,7 @@ code为200即为成功。
```
## 2、置顶列表接口##
置顶列表接口（app.grass.topArticleList)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
| uid | Integer | 是 | 380463 | 0 | 用户id |
注意，通用的头部没有列出。
请求示例
http://api-test3.dev.yohocorp.com/?method=app.grass.topArticleList&page=1&limit=10
### 响应
code为200即为成功。
响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"list": [
{
"articleId": 14,
"articleType": 1,
"authorHeadIco": "http://head.static.yhbimg.com/yhb-head/2018/10/19/14/01c349dfd4e467b7ca208e355eeb921122.jpg?imageView2/{mode}/w/{width}/h/{height}",
"authorName": "admire102",
"authorType": 1,
"authorUid": 500031572,
"content": "测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容测试文本内容",
"coverImage": "http://img11.static.yhbimg.com/yhb-img01/2016/12/16/18/01c84b87d28efe5e733367aa8aa91c02a6.jpg",
"favoriteCount": 0,
"hasFavor": "N",
"publishTime": 1547703633,
"publishTimeStr": "2019-01-17 13:40:33"
}
],
"totalCount": 1,
},
"message": "success"
}
```
## 3、商品种草接口##
... ...