Authored by chaogeng

资讯管理接口文档

  1 +资讯管理接口服务定义
  2 +---------------------
  3 +
  4 +
  5 +
  6 +## 资讯列表查询
  7 +
  8 +> 接口名: 'article/getList'
  9 +
  10 +### 入参
  11 +
  12 +-------------------------
  13 +|属性名称|类型|例子|说明|
  14 +|--------|----|----|----|
  15 +|articleTitle|String|尖货盘点|资讯标题|
  16 +|articleGender|String|1|性别|
  17 +|authorId|int|2890|作者ID|
  18 +|maxSortId|int|12|分类ID|
  19 +|status|int|1|资讯状态|
  20 +|orderBy|String|1|时间方式|
  21 +|startTime|String|2016-01-01|开始时间|
  22 +|endTime|String|2016-02-01|结束时间|
  23 +---------------------
  24 +
  25 +### 返回
  26 +
  27 +``` json
  28 +{
  29 + "code":200,
  30 + "message":"操作成功",
  31 + "data": {
  32 + "list": [
  33 + {
  34 + "id": "",
  35 + “coverImage": "", //封面图
  36 + "articleTitle": "", //资讯标题
  37 + "maxSortId": "", //分类
  38 + "articleGender": "", //性别
  39 + "authorId": "", //作者
  40 + "status": "", //状态,-1已关闭,0 未发布,1 已发布
  41 + "createTime": "", //创建时间
  42 + "publishTime": "", //发布时间
  43 + },
  44 + "page": 0,
  45 + "size": 50,
  46 + "total": 1000
  47 + "totalPage":20
  48 + ]
  49 + }
  50 +}
  51 +
  52 +```
  53 +
  54 +
  55 +## 获取作者列表接口
  56 +
  57 +> 接口名: 'article/getAuthorList'
  58 +
  59 +### 入参
  60 +
  61 +-------------------------
  62 +|属性名称|类型|例子|说明|
  63 +|--------|----|----|----|
  64 +|idName|String|1054|作者ID或姓名|
  65 +---------------------
  66 +
  67 +### 返回
  68 +
  69 +``` json
  70 +{
  71 + "code":200,
  72 + "message":"操作成功",
  73 + "data": [
  74 + {
  75 + "id": "",
  76 + "name":""
  77 + }
  78 + ]
  79 +
  80 +}
  81 +
  82 +```
  83 +
  84 +
  85 +## 获取所有分类接口
  86 +
  87 +> 接口名: 'article/getSortList'
  88 +
  89 +### 入参
  90 +
  91 +
  92 +
  93 +### 返回
  94 +
  95 +``` json
  96 +{
  97 + "code":200,
  98 + "message":"操作成功",
  99 + "data": [
  100 + {
  101 + "id": "",
  102 + "name":""
  103 + }
  104 + ]
  105 +}
  106 +
  107 +```
  108 +
  109 +## 编辑时资讯详情接口
  110 +
  111 +> 接口名: 'article/getArticleDetail'
  112 +
  113 +### 入参
  114 +
  115 +-------------------------
  116 +|属性名称|类型|例子|说明|
  117 +|--------|----|----|----|
  118 +|id|int|43|资讯id|
  119 +---------------------
  120 +
  121 +### 返回
  122 +
  123 +``` json
  124 +{
  125 + "code":200,
  126 + "message":"操作成功",
  127 + "data": {
  128 + "id": "",
  129 + “coverImage": "", //封面图
  130 + "articleTitle": "", //资讯标题
  131 + "maxSortId": "", //一级分类
  132 + "minSortId": "", //二级分类
  133 + "articleSummary": "",//摘要
  134 + "coverImageType": "",//图片类型
  135 + "articleType": "", //文章类型
  136 + "adsImgSize": "", //广告尺寸
  137 + "url": "", //链接
  138 + "articleGender": "", //性别
  139 + "authorId": "", //作者
  140 + "status": "", //状态,-1已关闭,0 未发布,1 已发布
  141 + "createTime": "", //创建时间
  142 + "publishTime": "", //发布时间
  143 + }
  144 +}
  145 +
  146 +```
  147 +
  148 +
  149 +## 新增资讯接口
  150 +
  151 +> 接口名: 'article/addArticle'
  152 +
  153 +### 入参
  154 +
  155 +-------------------------
  156 +|属性名称|类型|例子|说明|
  157 +|--------|----|----|----|
  158 +|articleTitle|String|尖货盘点|资讯标题|
  159 +|articleGender|String|0|性别|
  160 +|authorId|int|3098|作者ID|
  161 +|maxSortId|int|12|一级分类ID|
  162 +|minSortId|int|35|二级分类ID|
  163 +|articleSummary|String|御寒首选|摘要|
  164 +|coverImage|String||封面图|
  165 +|coverImageType|int|1|图片类型|
  166 +|articleType|int|1|文章类型|
  167 +|adsImgSize|String|10881088|广告尺寸|
  168 +|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接|
  169 +---------------------
  170 +
  171 +### 返回
  172 +
  173 +``` json
  174 +{
  175 + "code":200,
  176 + "message":"添加成功!"
  177 +}
  178 +
  179 +```
  180 +
  181 +## 修改/发布(关闭)/推荐(取消推荐)资讯接口
  182 +
  183 +> 接口名: 'article/addArticle'
  184 +
  185 +### 入参
  186 +
  187 +-------------------------
  188 +|属性名称|类型|例子|说明|
  189 +|--------|----|----|----|
  190 +|id|int|1054|资讯ID|
  191 +|articleTitle|String|尖货盘点|资讯标题|
  192 +|articleGender|String|0|性别|
  193 +|authorId|int|3098|作者ID|
  194 +|maxSortId|int|12|一级分类ID|
  195 +|minSortId|int|35|二级分类ID|
  196 +|articleSummary|String|御寒首选|摘要|
  197 +|coverImage|String||封面图|
  198 +|coverImageType|int|1|图片类型|
  199 +|articleType|int|1|文章类型|
  200 +|adsImgSize|String|10881088|广告尺寸|
  201 +|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"|链接|
  202 +---------------------
  203 +
  204 +### 返回
  205 +
  206 +``` json
  207 +{
  208 + "code":200,
  209 + "message":"修改成功!"
  210 +}
  211 +
  212 +```
  213 +
  214 +## 删除资讯接口
  215 +
  216 +> 接口名: 'article/delArticle'
  217 +
  218 +### 入参
  219 +
  220 +-------------------------
  221 +|属性名称|类型|例子|说明|
  222 +|--------|----|----|----|
  223 +|id|int|43|资讯id|
  224 +---------------------
  225 +
  226 +### 返回
  227 +
  228 +``` json
  229 +{
  230 + "code":200,
  231 + "message":"删除成功!"
  232 +}
  233 +
  234 +```
  235 +
  236 +## 定时发布资讯接口
  237 +
  238 +> 接口名: 'article/timePublish'
  239 +
  240 +### 入参
  241 +
  242 +-------------------------
  243 +|属性名称|类型|例子|说明|
  244 +|--------|----|----|----|
  245 +|id|int|43|资讯id|
  246 +|publishTime|int|1432188073|定时发布时间|
  247 +---------------------
  248 +
  249 +### 返回
  250 +
  251 +``` json
  252 +{
  253 + "code":200,
  254 + "message":"定时发布成功!"
  255 +}
  256 +
  257 +```
  258 +
  259 +## 资讯获取选择选项的枚举接口
  260 +
  261 +> 接口名: 'EnumListRest/getEnumList'
  262 +
  263 +### 返回
  264 +
  265 +``` json
  266 +{
  267 + "code":200,
  268 + "message":"请求成功",
  269 + "data": {
  270 + "genderItems": [{ //性别
  271 + "id": "",
  272 + "name": ""
  273 + }],
  274 + "publishStatusItems": [{ //发布状态
  275 + "id": "",
  276 + "name": ""
  277 + }],
  278 + "articleTypeItems": [{ //文章类型
  279 + "id": "",
  280 + "name": ""
  281 + }],
  282 + "coverImageTypeItems": [{ //封面图片类型
  283 + "id": "",
  284 + "name": ""
  285 + }],
  286 + "adsImgSizeItems": [{ //广告尺寸
  287 + "id": "",
  288 + "name": ""
  289 + }]
  290 + }
  291 +}
  292 +
  293 +```
  294 +
  295 +```