Yoho-Documents / Share · Commits

Go to a project

Authored by wangning
Commit 5b508735fa09b1e58c22c6093e0036ac4fc9f62e 1 parent 4585e197

格式修改

Inline Side-by-side
Showing 1 changed file with 129 additions and 17 deletions
1 # ArticleBrandRelatedController 文章相关的品牌信息以及文章内容相关的其他文章 # 1 # ArticleBrandRelatedController 文章相关的品牌信息以及文章内容相关的其他文章 #
2 -## 1. getBrandRelatedByArticle方法 ## 2 +## 1.getBrandRelatedByArticle方法 ##
3 3
4 - - 参数：article_id文章id  
5 - client_type客户端类型 4 + -请求参数：
6 5
7 - 6 +| 参数名称 | 参数类型 | 可否为空 | 备注 |
  7 +|:-------| -----:|-----:|-----:|
  8 +|article_id|int|否|作者id |
  9 +|client_type|string|否|客户端类型|
8 10
9 - - 方法解释：获取文章相关的品牌信息。 11 + -方法解释：获取文章相关的品牌信息。
10 12
11 - - 实现逻辑： 13 + -实现逻辑：
12 14
13 1.进入ArticleBrandController.getArticleByBrand方法，调用sns.getBrandRelatedByArticle服务 15 1.进入ArticleBrandController.getArticleByBrand方法，调用sns.getBrandRelatedByArticle服务
14 2.对参数article_id进行非空和是否大于0校验 16 2.对参数article_id进行非空和是否大于0校验
@@ -17,16 +19,48 @@ @@ -17,16 +19,48 @@
17 5.product.queryBrandByIds服务中根据brandIds查询表yh_shops.brand获得详细品牌信息 19 5.product.queryBrandByIds服务中根据brandIds查询表yh_shops.brand获得详细品牌信息
18 5.封装数据并返回 20 5.封装数据并返回
19 21
20 - - 示例： 22 + -示例：
21 请求：localhost:8080/gateway/guang/service/*/article/getBrand?article_id=1&client_type=h5&debug=XYZ 23 请求：localhost:8080/gateway/guang/service/*/article/getBrand?article_id=1&client_type=h5&debug=XYZ
22 24
23 返回： 25 返回：
24 26
25 -  
26 -{"alg":"SALT_MD5","code":200,"data":[{"id":"138","name":"THETHING","thumb":"http://img11.static.yhbimg.com/brandLogo/2015/12/09/16/018d25bf4481ed2998bf33b294673a8535.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80","url":"http://thething.m.yohobuy.com"},{"id":"313","name":"Reebok","thumb":"http://img11.static.yhbimg.com/brandLogo/2015/12/09/16/01b024238920cd70d5b276ba37244cfdfe.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80","url":"http://reebok.m.yohobuy.com"},{"id":"397","name":"Pineal Body","thumb":"http://img10.static.yhbimg.com/brandLogo/2015/12/03/15/013b75be7b5b6888aa7935b84abc02276c.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80","url":"http://pinealbody.m.yohobuy.com"},{"id":"518","name":"CLOTtee","thumb":"http://img11.static.yhbimg.com/brandLogo/2015/12/03/15/01de6bf632d371c2d6c5f74c212aa284fb.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80","url":"http://clottee.m.yohobuy.com"}],"md5":"dc0765a5ea1b974af3db9966a71843ea","message":"文章相关品牌列表"}  
27 -  
28 -  
29 -## 2. getOtherArticle方法 ## 27 +```
  28 +{
  29 + "alg": "SALT_MD5",
  30 + "code": 200,
  31 + "data": [
  32 + {
  33 + "id": "138",
  34 + "name": "THETHING",
  35 + "thumb": "http://img11.static.yhbimg.com/brandLogo/2015/12/09/16/018d25bf4481ed2998bf33b294673a8535.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80",
  36 + "url": "http://thething.m.yohobuy.com"
  37 + },
  38 + {
  39 + "id": "313",
  40 + "name": "Reebok",
  41 + "thumb": "http://img11.static.yhbimg.com/brandLogo/2015/12/09/16/01b024238920cd70d5b276ba37244cfdfe.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80",
  42 + "url": "http://reebok.m.yohobuy.com"
  43 + },
  44 + {
  45 + "id": "397",
  46 + "name": "Pineal Body",
  47 + "thumb": "http://img10.static.yhbimg.com/brandLogo/2015/12/03/15/013b75be7b5b6888aa7935b84abc02276c.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80",
  48 + "url": "http://pinealbody.m.yohobuy.com"
  49 + },
  50 + {
  51 + "id": "518",
  52 + "name": "CLOTtee",
  53 + "thumb": "http://img11.static.yhbimg.com/brandLogo/2015/12/03/15/01de6bf632d371c2d6c5f74c212aa284fb.jpg?imageMogr2/thumbnail/100x100/extent/100x100/background/d2hpdGU=/position/center/quality/80",
  54 + "url": "http://clottee.m.yohobuy.com"
  55 + }
  56 + ],
  57 + "md5": "dc0765a5ea1b974af3db9966a71843ea",
  58 + "message": "文章相关品牌列表"
  59 +}
  60 +```
  61 +
  62 +
  63 +## 2.getOtherArticle方法 ##
30 64
31 - 参数：tags文章标签 65 - 参数：tags文章标签
32 article_id文章id 66 article_id文章id
@@ -34,17 +68,95 @@ @@ -34,17 +68,95 @@
34 offset偏移量 68 offset偏移量
35 limit返回条数 69 limit返回条数
36 70
37 - - 方法解释：查询某文章内容的其他推荐文章 71 + -请求参数：
  72 +
  73 +| 参数名称 | 参数类型 | 可否为空 | 备注 |
  74 +|:-------| -----:|-----:|-----:|
  75 +|article_id|int|否|作者id |
  76 +|client_type|string|否|客户端类型|
  77 +|tags|string|否|文章标签|
  78 +|offset|int|否|偏移量|
  79 +|limit|int|否|返回条数|
38 80
39 - - 实现逻辑： 81 +
  82 + -方法解释：查询某文章内容的其他推荐文章
  83 +
  84 + -实现逻辑：
40 85
41 1.进入ArticleBrandController.getOtherArticle方法，调用sns.getOtherArticle服务 86 1.进入ArticleBrandController.getOtherArticle方法，调用sns.getOtherArticle服务
42 2.查询表yh_guang.article获取关联文章 87 2.查询表yh_guang.article获取关联文章
43 5.封装数据并返回 88 5.封装数据并返回
44 89
45 90
46 - - 示例： 91 + -示例：
  92 +
47 请求：http://localhost:8080/gateway/guang/service/*/article/getOtherArticle?tags=1&article_id=1&client_type=h5&debug=XYZ 93 请求：http://localhost:8080/gateway/guang/service/*/article/getOtherArticle?tags=1&article_id=1&client_type=h5&debug=XYZ
48 -返回：  
49 94
50 -{"alg":"SALT_MD5","code":200,"data":[{"cover_image_type":0,"id":34194,"publishTime":"1月1日 08:00","thumb":"http://img13.static.yhbimg.com/article/2016/05/12/13/02a090a95f0835b2c2303006aeda8394a8.jpg?imageView/{mode}/w/{width}/h/{height}","title":"3433","url":"http://guang.m.yohobuy.com/info/index?id=34194"},{"cover_image_type":0,"id":31626,"publishTime":"1月1日 08:00","thumb":"http://img11.static.yhbimg.com/yhb-img01/2016/01/08/03/01aca577c1fbc471f1c76ccaff8f6e293b.jpg?imageView/{mode}/w/{width}/h/{height}","title":"「穿什么看这里」摆脱死气，2016该玩亮色了！","url":"http://guang.m.yohobuy.com/info/index?id=31626"},{"cover_image_type":1,"id":31240,"publishTime":"1月1日 08:00","thumb":"http://img11.static.yhbimg.com/yhb-img01/2016/01/05/08/0178ba5df3aa0980d98ac0908f48cf6ffe.jpg?imageView/{mode}/w/{width}/h/{height}","title":"高性价比MA-1夹克，要潮也不用剁手！","url":"http://guang.m.yohobuy.com/info/index?id=31240"},{"cover_image_type":1,"id":30748,"publishTime":"1月1日 08:00","thumb":"http://img11.static.yhbimg.com/yhb-img01/2015/12/30/07/01669a446d1b1d1a24ac2bea91dc5c5b2e.jpg?imageView/{mode}/w/{width}/h/{height}","title":"2016你要改头换面？那你需要先换掉它！","url":"http://guang.m.yohobuy.com/info/index?id=30748"},{"cover_image_type":1,"id":28136,"publishTime":"1月1日 08:00","thumb":"http://img12.static.yhbimg.com/yhb-img01/2015/12/11/09/0210e01fd064eaa4769b45b869cb74bf98.gif?imageView/{mode}/w/{width}/h/{height}","title":"【年末潮流回顾】2015这些联名一度炸翻潮流圈！","url":"http://guang.m.yohobuy.com/info/index?id=28136"},{"cover_image_type":0,"id":27626,"publishTime":"1月1日 08:00","thumb":"http://img12.static.yhbimg.com/yhb-img01/2015/12/09/08/02a429e4c9500ce61407dd210531c1257f.jpg?imageView/{mode}/w/{width}/h/{height}","title":"加长下摆依然继续！给你层叠的HI—STEET！","url":"http://guang.m.yohobuy.com/info/index?id=27626"},{"cover_image_type":0,"id":20283,"publishTime":"1月1日 08:00","thumb":"http://img11.static.yhbimg.com/yhb-img01/2015/10/21/09/01a18a865f5de0355aa5e72bd68f8b7b5a.jpg?imageView/{mode}/w/{width}/h/{height}","title":"「来自编辑部的私家推荐」话题编辑Naoki闹的MA-1出街造型","url":"http://guang.m.yohobuy.com/info/index?id=20283"}],"md5":"3aca41942b3b1d40b8810b5ce356f97e","message":"文章相关内容列表"}  
  95 +
  96 +返回：
  97 +```
  98 +{
  99 + "alg": "SALT_MD5",
  100 + "code": 200,
  101 + "data": [
  102 + {
  103 + "cover_image_type": 0,
  104 + "id": 34194,
  105 + "publishTime": "1月1日 08:00",
  106 + "thumb": "http://img13.static.yhbimg.com/article/2016/05/12/13/02a090a95f0835b2c2303006aeda8394a8.jpg?imageView/{mode}/w/{width}/h/{height}",
  107 + "title": "3433",
  108 + "url": "http://guang.m.yohobuy.com/info/index?id=34194"
  109 + },
  110 + {
  111 + "cover_image_type": 0,
  112 + "id": 31626,
  113 + "publishTime": "1月1日 08:00",
  114 + "thumb": "http://img11.static.yhbimg.com/yhb-img01/2016/01/08/03/01aca577c1fbc471f1c76ccaff8f6e293b.jpg?imageView/{mode}/w/{width}/h/{height}",
  115 + "title": "「穿什么看这里」摆脱死气，2016该玩亮色了！",
  116 + "url": "http://guang.m.yohobuy.com/info/index?id=31626"
  117 + },
  118 + {
  119 + "cover_image_type": 1,
  120 + "id": 31240,
  121 + "publishTime": "1月1日 08:00",
  122 + "thumb": "http://img11.static.yhbimg.com/yhb-img01/2016/01/05/08/0178ba5df3aa0980d98ac0908f48cf6ffe.jpg?imageView/{mode}/w/{width}/h/{height}",
  123 + "title": "高性价比MA-1夹克，要潮也不用剁手！",
  124 + "url": "http://guang.m.yohobuy.com/info/index?id=31240"
  125 + },
  126 + {
  127 + "cover_image_type": 1,
  128 + "id": 30748,
  129 + "publishTime": "1月1日 08:00",
  130 + "thumb": "http://img11.static.yhbimg.com/yhb-img01/2015/12/30/07/01669a446d1b1d1a24ac2bea91dc5c5b2e.jpg?imageView/{mode}/w/{width}/h/{height}",
  131 + "title": "2016你要改头换面？那你需要先换掉它！",
  132 + "url": "http://guang.m.yohobuy.com/info/index?id=30748"
  133 + },
  134 + {
  135 + "cover_image_type": 1,
  136 + "id": 28136,
  137 + "publishTime": "1月1日 08:00",
  138 + "thumb": "http://img12.static.yhbimg.com/yhb-img01/2015/12/11/09/0210e01fd064eaa4769b45b869cb74bf98.gif?imageView/{mode}/w/{width}/h/{height}",
  139 + "title": "【年末潮流回顾】2015这些联名一度炸翻潮流圈！",
  140 + "url": "http://guang.m.yohobuy.com/info/index?id=28136"
  141 + },
  142 + {
  143 + "cover_image_type": 0,
  144 + "id": 27626,
  145 + "publishTime": "1月1日 08:00",
  146 + "thumb": "http://img12.static.yhbimg.com/yhb-img01/2015/12/09/08/02a429e4c9500ce61407dd210531c1257f.jpg?imageView/{mode}/w/{width}/h/{height}",
  147 + "title": "加长下摆依然继续！给你层叠的HI—STEET！",
  148 + "url": "http://guang.m.yohobuy.com/info/index?id=27626"
  149 + },
  150 + {
  151 + "cover_image_type": 0,
  152 + "id": 20283,
  153 + "publishTime": "1月1日 08:00",
  154 + "thumb": "http://img11.static.yhbimg.com/yhb-img01/2015/10/21/09/01a18a865f5de0355aa5e72bd68f8b7b5a.jpg?imageView/{mode}/w/{width}/h/{height}",
  155 + "title": "「来自编辑部的私家推荐」话题编辑Naoki闹的MA-1出街造型",
  156 + "url": "http://guang.m.yohobuy.com/info/index?id=20283"
  157 + }
  158 + ],
  159 + "md5": "3aca41942b3b1d40b8810b5ce356f97e",
  160 + "message": "文章相关内容列表"
  161 +}
  162 +```