platform / yohobuy-doc · Commits

Go to a project

Authored by bblu
Commit 563eaf7502685c853c825244c2e32745d45eb3ee 1 parent 9312b269

修改

Inline Side-by-side
Showing 18 changed files with 141 additions and 140 deletions
... ... @@ -11,20 +11,20 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|articleTitle|String|尖货盘点|资讯标题|
|articleGender|String|0|性别|
|authorId|int|3098|作者ID|
|maxSortId|int|12|一级分类ID|
|minSortId|int|35|二级分类ID|
|articleSummary|String|御寒首选|摘要|
|coverImage|String||封面图|
|coverImageType|int|1|图片类型|
|articleType|int|1|文章类型|
|adsImgSize|String|10881088|广告尺寸|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"}|链接|
|contentData|String|[{"templateKey":"singleImage","contentData":{"template_name":"singleImage","template_intro":"一张图片","data":{"0":{"url":{},"alt":"","src":""}}}"}]文章内容|
|brands|String|[{"id":102,"brandCategory":1},{"id":103,"brandCategory":2}]|关联品牌信息,brandCategory 1 yohobuy品牌 2 全球购品牌|
|tag|String|欧美,复古,街头|文章标签|
|articleTitle|String|尖货盘点|资讯标题||1-85|
|articleGender|String|0|性别||1-1|
|authorId|int|3098|作者ID||1-11|
|maxSortId|int|12|一级分类ID||1-11|
|minSortId|int|35|二级分类ID||1-11|
|articleSummary|String|御寒首选|摘要||1-85|
|coverImage|String||封面图||1-200|
|coverImageType|int|1|图片类型||1-1|
|articleType|int|1|文章类型||1-1|
|adsImgSize|String|10881088|广告尺寸||2-20|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"}|链接||22-166|
|contentData|String|[{"templateKey":"singleImage","contentData":{"template_name":"singleImage","template_intro":"一张图片","data":{"0":{"url":{},"alt":"","src":""}}}"}]文章内容||-|
|brands|String|[{"id":102,"brandCategory":1},{"id":103,"brandCategory":2}]|关联品牌信息,brandCategory 1 yohobuy品牌 2 全球购品牌||-|
|tag|String|欧美,复古,街头|文章标签||-|
---------------------
... ...
... ... @@ -11,7 +11,7 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|范围|
|--------|----|----|----|----|----|
|id|int|43|资讯id|是|10|
|id|int|43|资讯id|是|1-11|
---------------------
... ...
... ... @@ -11,7 +11,7 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|idName|String|8168248|作者ID或姓名|
|idName|String|8168248|作者ID或姓名||1-30|
---------------------
请求示例 http://172.16.6.157:8080/yohobuy-platform-web/guang/article/getAuthorList?idName=8168248
... ...
... ... @@ -11,7 +11,7 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|int|3|资讯id|
|id|int|3|资讯id||1-11|
---------------------
... ...
... ... @@ -7,14 +7,14 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|articleTitle|String|尖货盘点|资讯标题|||
|articleGender|String|1|性别||||
|authorId|int|2890|作者ID||||
|maxSortId|int|12|分类ID||||
|status|int|1|资讯状态||||
|orderBy|String|1|时间方式||||
|startTime|String|2016-01-01|开始时间||||
|endTime|String|2016-02-01|结束时间||||
|articleTitle|String|尖货盘点|资讯标题||1-85|
|articleGender|String|1|性别||1-1|
|authorId|int|2890|作者ID||1-11|
|maxSortId|int|12|分类ID||1-11|
|status|int|1|资讯状态||1-1|
|orderBy|String|1|时间方式||12-13|
|startTime|String|2016-01-01|开始时间||10-10|
|endTime|String|2016-02-01|结束时间||10-10|
---------------------
### 返回
... ...
... ... @@ -11,7 +11,7 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|parentId|int|0|上级分类id|
|parentId|int|0|上级分类id||1-11|
---------------------
... ...
... ... @@ -11,8 +11,8 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|int|33615|资讯id|
|publishTime|String|2016-02-19 16:17|定时发布时间|
|id|int|33615|资讯id||1-11|
|publishTime|String|2016-02-19 16:17|定时发布时间||16-19|
---------------------
... ...
... ... @@ -11,23 +11,23 @@
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|int|1054|资讯ID|
|articleTitle|String|尖货盘点|资讯标题|
|articleGender|String|0|性别|
|authorId|int|3098|作者ID|
|maxSortId|int|12|一级分类ID|
|minSortId|int|35|二级分类ID|
|articleSummary|String|御寒首选|摘要|
|coverImage|String||封面图|
|coverImageType|int|1|图片类型|
|articleType|int|1|文章类型|
|adsImgSize|String|10881088|广告尺寸|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"}|链接|
|contentData|String|[{"id": 59,"orderBy":1,"templateKey":"singleImage","contentData":{"template_name":"singleImage","template_intro":"一张图片","data":{"0":{"url":{},"alt":"","src":""}}}"}]|文章内容|
|brands|String|[{"id":102,"brandCategory":1},{"id":103,"brandCategory":2}]|关联品牌信息,brandCategory 1 yohobuy品牌 2 全球购品牌|
|tag|String|欧美,复古,街头|文章标签|
|status|int|1(-1)|发布(关闭)|
|isRecommend|int|1(0)|推荐(取消推荐)|
|id|int|1054|资讯ID||1-11|
|articleTitle|String|尖货盘点|资讯标题||1-85|
|articleGender|String|0|性别||1-1|
|authorId|int|3098|作者ID||1-11|
|maxSortId|int|12|一级分类ID||1-11|
|minSortId|int|35|二级分类ID||1-11|
|articleSummary|String|御寒首选|摘要||1-85|
|coverImage|String||封面图||1-200|
|coverImageType|int|1|图片类型||1-1|
|articleType|int|1|文章类型||1-1|
|adsImgSize|String|10881088|广告尺寸||2-20|
|url|String|{"action":"go.activity","url":"http://feature.yohobuy.com/0/0/373/index.html"}|链接||22-166|
|contentData|String|[{"id": 59,"orderBy":1,"templateKey":"singleImage","contentData":{"template_name":"singleImage","template_intro":"一张图片","data":{"0":{"url":{},"alt":"","src":""}}}"}]|文章内容||-|
|brands|String|[{"id":102,"brandCategory":1},{"id":103,"brandCategory":2}]|关联品牌信息,brandCategory 1 yohobuy品牌 2 全球购品牌||-|
|tag|String|欧美,复古,街头|文章标签||-|
|status|int|1(-1)|发布(关闭)||1-2|
|isRecommend|int|1(0)|推荐(取消推荐)||1-1|
---------------------
... ...
... ... @@ -8,13 +8,13 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|parent_id|Integer|1|父类分类|
|name|String|流行|分类名称|
|status|Byte|1|状态|
|orderBy|Byte|3|排序|
|advertCode|String|324dfasf|广告码|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|parent_id|Integer|1|父类分类||1-11|
|name|String|流行|分类名称||1-6|
|status|Byte|1|状态||1-1|
|orderBy|Byte|3|排序||1-4|
|advertCode|String|324dfasf|广告码||1-32|
---------------------
... ... @@ -81,9 +81,9 @@
### 返回
json
``` json
{
"code": "200",
"message":"增加成功"
}
```
... ...
... ... @@ -8,9 +8,9 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|Integer|1|ID主键|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|Integer|1|ID主键||1-11|
---------------------
... ... @@ -34,9 +34,9 @@
### 返回
json
``` json
{
"code": "200",
"message":"删除成功"
}
```
... ...
... ... @@ -8,12 +8,12 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|name|String|流行|分类名称|
|status|Byte|1|状态|
|orderBy|Byte|3|排序|
|advertCode|String|324dfasf|广告码|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|name|String|流行|分类名称||1-6|
|status|Byte|1|状态||1-1|
|orderBy|Byte|3|排序||1-4|
|advertCode|String|324dfasf|广告码||1-32|
---------------------
... ...
... ... @@ -8,12 +8,12 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|tagName|String|运动|标签名称|
|classifyId|String|2|分类名称|
|status|String|1|是否启用|
|isHot|String|1|是否热门|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|tagName|String|运动|标签名称||1-6|
|classifyId|String|2|分类名称||1-11|
|status|String|1|是否启用||1-1|
|isHot|String|1|是否热门||1-1|
---------------------
... ...
... ... @@ -8,9 +8,9 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|Integer|1|ID主键|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|Integer|1|ID主键||1-11|
---------------------
... ...
... ... @@ -8,11 +8,11 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|tagName|String|运动|标签名称|
|classifyId|String|2|分类名称|
|isHot|String|1|是否热门|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|tagName|String|运动|标签名称||1-6|
|classifyId|String|2|分类名称||1-11|
|isHot|String|1|是否热门||1-1|
... ...
... ... @@ -8,13 +8,13 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|int|1|ID主键|
|tagName|String|运动|标签名称|
|classifyId|String|2|分类名称|
|status|String|1|是否启用|
|isHot|String|1|是否热门|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|int|1|ID主键||1-11|
|tagName|String|运动|标签名称||1-6|
|classifyId|String|2|分类名称||1-11|
|status|String|1|是否启用||1-1|
|isHot|String|1|是否热门||1-1|
---------------------
... ...
... ... @@ -8,11 +8,11 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|username|String|路遥|名称|
|authorDesc|String|平凡世界。。。|描述|
|avatar|String|http://img12.static.yhbimg.com/yhb-img02/2015/06/12/14/0220208c13de341448647b7eead758d592.jpg?imageView/{mode}/w/{width}/h/{height}|用户头像|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|username|String|路遥|名称||1-16|
|authorDesc|String|平凡世界。。。|描述||1-16|
|avatar|String|http://img12.static.yhbimg.com/yhb-img02/2015/06/12/14/0220208c13de341448647b7eead758d592.jpg?imageView/{mode}/w/{width}/h/{height}|用户头像||1-200|
---------------------
... ...
# 删除作者
> 接口名： /guang/author/delAuthor
### 方法
> POST
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|Integer|1|ID主键|
---------------------
### 对应SQL的操作库表
<delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
delete from author
where uid = #{uid,jdbcType=INTEGER}
</delete>
### 错误编码
-------------------------
|错误码code|消息|说明|
|--------|----|----|
|200|删除成功| |
|400|删除失败| |
### 返回
json
{
"code": "200",
"message":"删除成功"
}
# 删除作者
> 接口名： /guang/author/delAuthor
### 方法
> POST
### 入参
-------------------------
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|Integer|1|ID主键||1-11|
---------------------
### 对应SQL的操作库表
<delete id="deleteByPrimaryKey" parameterType="java.lang.Integer" >
delete from author
where uid = #{uid,jdbcType=INTEGER}
</delete>
### 错误编码
-------------------------
|错误码code|消息|说明|
|--------|----|----|
|200|删除成功| |
|400|删除失败| |
### 返回
``` json
{
"code": "200",
"message":"删除成功"
}
```
... ...
... ... @@ -8,12 +8,12 @@
### 入参
-------------------------
|属性名称|类型|例子|说明|
|--------|----|----|----|
|id|Integer|1|主键|
|username|String|路遥|名称|
|authorDesc|String|平凡世界。。。|描述|
|avatar|String|http://img12.static.yhbimg.com/yhb-img02/2015/06/12/14/0220208c13de341448647b7eead758d592.jpg?imageView/{mode}/w/{width}/h/{height}|用户头像|
|属性名称|类型|例子|说明|是否必填|长度限制|
|--------|----|----|----|----|----|
|id|Integer|1|主键||1-11|
|username|String|路遥|名称||1-16|
|authorDesc|String|平凡世界。。。|描述||1-16|
|avatar|String|http://img12.static.yhbimg.com/yhb-img02/2015/06/12/14/0220208c13de341448647b7eead758d592.jpg?imageView/{mode}/w/{width}/h/{height}|用户头像||1-200|
---------------------
... ... @@ -50,8 +50,9 @@
### 返回
json
``` json
{
"code": "200",
"message":"修改成功"
}
```
... ...