Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by 张帅
Commit c5b157fa916a3a8e542b3ab8cac95f9f9a66f3be 1 parent 5cae6964

新增接口文档

Inline Side-by-side
Showing 1 changed file with 268 additions and 0 deletions
  1 +## 提供给商品详情页的接口， 响应内容总数和详情页内容封面图##
  2 +
  3 +提供给商品详情页的接口， 响应内容总数和详情页内容封面图=app.grass.simpleProductArticle
  4 +#### 请求参数
  5 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|----:|
  7 +| uid | Integer | 是 | 1 | 1 | 用户uid |
  8 +| productSkn | Integer | 否 | | | 商品skn |
  9 +| productType | Integer | 否 | | | 商品类型， 1 有货商品 2 ufo商品 |
  10 +
  11 +注意，通用的头部没有列出。
  12 +请求示例
  13 +http://api-test3.dev.yohocorp.com/?app_version=6.9.17&business_line=yohobuy&method=app.grass.simpleProductArticle&udid=861243048197754cd2de191342aa531&debug=XYZ&uid=500031572&client_type=android&productSkn=512589648&productType=1
  14 +### 响应
  15 +code为200即为成功。
  16 +响应JSON格式如下所示:
  17 +```json
  18 +{
  19 + "alg": "SALT_MD5",
  20 + "code": 200,
  21 + "data": {
  22 + "list": [
  23 + {
  24 + "articleId": 140090,
  25 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/16/01ecf220f172f485f3dea1a25ca20367b4.jpg?imageView2/{mode}/w/{width}/h/{height}",
  26 + "dataType": 1,
  27 + "identityAuthStatus": "N",
  28 + "imageHeight": "1488",
  29 + "imageWidth": "1984"
  30 + },
  31 + {
  32 + "articleId": 140088,
  33 + "coverImage": "http://img11.static.yhbimg.com/grassImg/2019/02/25/15/016f0e54d55ea6be2c3d68e11e214bd013.jpg?imageView2/{mode}/w/{width}/h/{height}",
  34 + "dataType": 1,
  35 + "identityAuthStatus": "N",
  36 + "imageHeight": "1488",
  37 + "imageWidth": "1984"
  38 + },
  39 + {
  40 + "articleId": 140086,
  41 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/15/01fc64ef7ed5e2acd2083fb90f4ce96b8b.jpg?imageView2/{mode}/w/{width}/h/{height}",
  42 + "dataType": 1,
  43 + "identityAuthStatus": "N",
  44 + "imageHeight": "1488",
  45 + "imageWidth": "1984"
  46 + },
  47 + {
  48 + "articleId": 140084,
  49 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/15/01c5617e0ff07544060216780172bb23be.jpg?imageView2/{mode}/w/{width}/h/{height}",
  50 + "dataType": 1,
  51 + "identityAuthStatus": "N",
  52 + "imageHeight": "1984",
  53 + "imageWidth": "1488"
  54 + }
  55 + ],
  56 + "total": 6 //文章总数
  57 + },
  58 + "md5": "f6319404019248097fa09a0aac559665",
  59 + "message": "操作成功"
  60 +}
  61 +```
  62 +
  63 +
  64 +
  65 +## 2、全部内容接口##
  66 +
  67 +全部内容接口， 响应同瀑布流（app.grass.productArticleList)
  68 +#### 请求参数
  69 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  70 +|:-------| -----:|-----:|-----:|-----:|----:|
  71 +| uid | Integer | 是 | 1 | 1 | 用户uid |
  72 +| productSkn | Integer | 否 | | | 商品skn |
  73 +| productType | Integer | 否 | | | 商品类型， 1 有货商品 2 ufo商品 |
  74 +| page | Integer | 否 | 1 | 1 | 页码 |
  75 +| limit | Integer | 否 | 1 | 10 | 每页显示条数 |
  76 +| lastedTime | String | 是 | "1548905701041" | null | 第一次请求或者刷新列表时不传, 接口会返回此字段，后续分页请求带上该字段值 |
  77 +
  78 +
  79 +
  80 +
  81 +注意，通用的头部没有列出。
  82 +请求示例
  83 +http://api-test3.dev.yohocorp.com/?app_version=6.9.17&business_line=yohobuy&method=app.grass.productArticleList&udid=861243048197754cd2de191342aa531&debug=XYZ&uid=500031572&client_type=android&productSkn=512589648&productType=1&page=1&limit
  84 +### 响应
  85 +code为200即为成功。
  86 +响应JSON格式如下所示:
  87 +```json
  88 +{
  89 + "code": 200,
  90 + "data": {
  91 +{
  92 + "lastedTime": "1551085098434",
  93 + "list": [
  94 + {
  95 + "articleId": 140090,
  96 + "articleType": 1,
  97 + "authStatus": 1,
  98 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  99 + "authorName": "",
  100 + "authorType": 1,
  101 + "authorUid": 500031928,
  102 + "content": "童可可恶露饿了",
  103 + "copyright": "原创",
  104 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/16/01ecf220f172f485f3dea1a25ca20367b4.jpg?imageView2/{mode}/w/{width}/h/{height}",
  105 + "dataType": 1,
  106 + "favoriteCount": 3,
  107 + "hasFavor": "N",
  108 + "hasPraise": "N",
  109 + "hasPraised": "N",
  110 + "identityAuthStatus": "N",
  111 + "imageHeight": "1488",
  112 + "imageWidth": "1984",
  113 + "isTop": 0,
  114 + "isTopicTop": 0,
  115 + "praiseCount": 66,
  116 + "publishTime": 1551085098434,
  117 + "publishTimeStr": "2019-02-25 16:58:18",
  118 + "recommendFlag": 1,
  119 + "sort": 1
  120 + },
  121 + {
  122 + "articleId": 140088,
  123 + "articleType": 1,
  124 + "authStatus": 1,
  125 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  126 + "authorName": "",
  127 + "authorType": 1,
  128 + "authorUid": 500031928,
  129 + "content": "恶露饿了吧服了饿了不了不可听觉哭的图册打他扶额酷不酷答复现阿轲不饿补补嘟啊嘟嘴阿轲不测特鲁大师扶额可苦可乐不塌可恶咳咳咳他不特鲁可疼了八路乐途客服了附近不测特KTV的跨服不发扶她饿不阿拉嘟啊嘟刻苦啊特特他不阿德不测他的啊服了太绝了剧毒快乐同乐同乐福不不不侧踏扶她饿不饿不服测测AK补虐卡特拒绝路哭了多久补聚聚推荐！阿拉饿了他啊嘟嘟嘟特服阿轲不饿特步侧部肚肚饿绝句发了饿了不饿不饿不额绝句剧毒吐的绝句福不可特特哭了吐了咳咳咳特鲁绝JOJO裤头LOL饿酷酷哒特特路饿不饿不饿略略略虐了热略略略夸他落楼哦觉咯图恩透露了6天了噜服了剧毒┗┃・ ■ ・┃┛不可吐了军绿路疼哭了略读付款了屠夫额可痛苦了童可可路8",
  130 + "copyright": "原创",
  131 + "coverImage": "http://img11.static.yhbimg.com/grassImg/2019/02/25/15/016f0e54d55ea6be2c3d68e11e214bd013.jpg?imageView2/{mode}/w/{width}/h/{height}",
  132 + "dataType": 1,
  133 + "favoriteCount": 1,
  134 + "hasFavor": "N",
  135 + "hasPraise": "N",
  136 + "hasPraised": "N",
  137 + "identityAuthStatus": "N",
  138 + "imageHeight": "1488",
  139 + "imageWidth": "1984",
  140 + "isTop": 0,
  141 + "isTopicTop": 0,
  142 + "praiseCount": 74,
  143 + "publishTime": 1551079205646,
  144 + "publishTimeStr": "2019-02-25 15:20:05",
  145 + "recommendFlag": 1,
  146 + "sort": 1
  147 + },
  148 + {
  149 + "articleId": 140086,
  150 + "articleType": 1,
  151 + "authStatus": 1,
  152 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  153 + "authorName": "",
  154 + "authorType": 1,
  155 + "authorUid": 500031928,
  156 + "content": "恶露饿了吧服了饿了不了不可听觉哭的图册打他扶额酷不酷答复现阿轲不饿补补嘟啊嘟嘴阿轲不测特鲁大师扶额可苦可乐不塌可恶咳咳咳他不特鲁可疼了八路乐途客服了附近不测特KTV的跨服不发扶她饿不阿拉嘟啊嘟刻苦啊特特他不阿德不测他的啊服了太绝了剧毒快乐同乐同乐福不不不侧踏扶她饿不饿不服测测AK补虐卡特拒绝路哭了多久补聚聚推荐！阿拉饿了他啊嘟嘟嘟特服阿轲不饿特步侧部肚肚饿绝句发了饿了不饿不饿不额绝句剧毒吐的绝句福不可特特哭了吐了咳咳咳特鲁绝JOJO裤头LOL饿酷酷哒特特路饿不饿不饿略略略虐了热略略略夸他落楼哦觉咯图恩透露了6天了噜服了剧毒┗┃・ ■ ・┃┛不可吐了军绿路疼哭了略读付款了屠夫额可痛苦了童可可路8",
  157 + "copyright": "原创",
  158 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/15/01fc64ef7ed5e2acd2083fb90f4ce96b8b.jpg?imageView2/{mode}/w/{width}/h/{height}",
  159 + "dataType": 1,
  160 + "favoriteCount": 1,
  161 + "hasFavor": "N",
  162 + "hasPraise": "N",
  163 + "hasPraised": "N",
  164 + "identityAuthStatus": "N",
  165 + "imageHeight": "1488",
  166 + "imageWidth": "1984",
  167 + "isTop": 0,
  168 + "isTopicTop": 0,
  169 + "praiseCount": 68,
  170 + "publishTime": 1551079160575,
  171 + "publishTimeStr": "2019-02-25 15:19:20",
  172 + "recommendFlag": 1,
  173 + "sort": 1
  174 + },
  175 + {
  176 + "articleId": 140084,
  177 + "articleType": 1,
  178 + "authStatus": 1,
  179 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  180 + "authorName": "",
  181 + "authorType": 1,
  182 + "authorUid": 500031928,
  183 + "content": "恶露饿了吧服了饿了不了不可听觉哭的图册打他扶额酷不酷答复现阿轲不饿补补嘟啊嘟嘴阿轲不测特鲁大师扶额可苦可乐不塌可恶咳咳咳他不特鲁可疼了八路乐途客服了附近不测特KTV的跨服不发扶她饿不阿拉嘟啊嘟刻苦啊特特他不阿德不测他的啊服了太绝了剧毒快乐同乐同乐福不不不侧踏扶她饿不饿不服测测AK补虐卡特拒绝路哭了多久补聚聚推荐！阿拉饿了他啊嘟嘟嘟特服阿轲不饿特步侧部肚肚饿绝句发了饿了不饿不饿不额绝句剧毒吐的绝句福不可特特哭了吐了咳咳咳特鲁绝JOJO裤头LOL饿酷酷哒特特路饿不饿不饿略略略虐了热略略略夸他落楼哦觉咯图恩透露了6天了噜服了剧毒┗┃・ ■ ・┃┛不可吐了军绿路疼哭了略读付款了屠夫额可痛苦了童可可路8",
  184 + "copyright": "原创",
  185 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/15/01c5617e0ff07544060216780172bb23be.jpg?imageView2/{mode}/w/{width}/h/{height}",
  186 + "dataType": 1,
  187 + "favoriteCount": 0,
  188 + "hasFavor": "N",
  189 + "hasPraise": "N",
  190 + "hasPraised": "N",
  191 + "identityAuthStatus": "N",
  192 + "imageHeight": "1984",
  193 + "imageWidth": "1488",
  194 + "isTop": 0,
  195 + "isTopicTop": 0,
  196 + "praiseCount": 21,
  197 + "publishTime": 1551079056499,
  198 + "publishTimeStr": "2019-02-25 15:17:36",
  199 + "recommendFlag": 1,
  200 + "sort": 1
  201 + },
  202 + {
  203 + "articleId": 140026,
  204 + "articleType": 1,
  205 + "authStatus": 1,
  206 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  207 + "authorName": "",
  208 + "authorType": 1,
  209 + "authorUid": 500031928,
  210 + "content": "花灯，中华门城堡",
  211 + "copyright": "原创",
  212 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/10/015d0501b458d8e6fb31997f65eaac19d0.jpg?imageView2/{mode}/w/{width}/h/{height}",
  213 + "dataType": 1,
  214 + "favoriteCount": 1,
  215 + "hasFavor": "N",
  216 + "hasPraise": "N",
  217 + "hasPraised": "N",
  218 + "identityAuthStatus": "N",
  219 + "imageHeight": "1984",
  220 + "imageWidth": "1488",
  221 + "isTop": 0,
  222 + "isTopicTop": 0,
  223 + "praiseCount": 93,
  224 + "publishTime": 1551061952660,
  225 + "publishTimeStr": "2019-02-25 10:32:32",
  226 + "recommendFlag": 1,
  227 + "sort": 1
  228 + },
  229 + {
  230 + "articleId": 140024,
  231 + "articleType": 1,
  232 + "authStatus": 1,
  233 + "authorHeadIco": "http://img11.static.yhbimg.com/yhb-img01/2016/07/05/13/017ec560b82c132ab2fdb22f7cf6f42b83.png?imageView/{mode}/w/{width}/h/{height}",
  234 + "authorName": "",
  235 + "authorType": 1,
  236 + "authorUid": 500031928,
  237 + "content": "花他特略略略略了额略略特",
  238 + "copyright": "原创",
  239 + "coverImage": "http://img10.static.yhbimg.com/grassImg/2019/02/25/10/01b8c270bc6fe5cc94a04e4eb760c1bef8.jpg?imageView2/{mode}/w/{width}/h/{height}",
  240 + "dataType": 1,
  241 + "favoriteCount": 1,
  242 + "hasFavor": "N",
  243 + "hasPraise": "N",
  244 + "hasPraised": "N",
  245 + "identityAuthStatus": "N",
  246 + "imageHeight": "1488",
  247 + "imageWidth": "1984",
  248 + "isTop": 0,
  249 + "isTopicTop": 0,
  250 + "praiseCount": 89,
  251 + "publishTime": 1551061283654,
  252 + "publishTimeStr": "2019-02-25 10:21:23",
  253 + "recommendFlag": 1,
  254 + "sort": 1
  255 + }
  256 + ],
  257 + "pageNo": 1,
  258 + "pageSize": 10,
  259 + "totalCount": 6,
  260 + "totalPage": 1,
  261 + "viewModel": 1
  262 +}
  263 + },
  264 + "message": "success"
  265 +}
  266 +```
  267 +
  268 +