qianjun / yohobuy-doc · Commits

Go to a project

Authored by liqingzhong
Commit 8fa1b49c8c8f80e5a2669f93fbf994b533021a13 1 parent 1b51d766

添加获取单个的接口文档

Inline Side-by-side
Showing 3 changed files with 62 additions and 0 deletions
@@ -57,6 +57,33 @@ @@ -57,6 +57,33 @@
57 } 57 }
58 ``` 58 ```
59 59
  60 +# 获取单个模板接口
  61 +
  62 +> 接口名：`activityTemplate/getTemplate`
  63 +
  64 +----------------------------------
  65 +|属性名称|类型|例子|说明|是否必填|
  66 +|--------|----|----|----|--------|
  67 +|id|integer|1|主键|是|
  68 +----------------------------------
  69 +
  70 +### 返回
  71 +
  72 +``` json
  73 +{
  74 + "code": 200,
  75 + "data": {
  76 + "createTime": 1456112240,
  77 + "id": 33,
  78 + "image": "图片地址",
  79 + "shareId": 0,
  80 + "title": "模板标题",
  81 + "url": "模板地址"
  82 + },
  83 + "message": "Temp Info"
  84 +}
  85 +```
  86 +
60 # 更新模板接口 87 # 更新模板接口
61 88
62 > 接口名：`activityTemplate/updateTeplate` 89 > 接口名：`activityTemplate/updateTeplate`
@@ -62,6 +62,36 @@ @@ -62,6 +62,36 @@
62 } 62 }
63 ``` 63 ```
64 64
  65 +# 根据 ID 获取标签接口
  66 +
  67 +### 入参
  68 +
  69 +----------------------------------
  70 +|属性名称|类型|例子|说明|是否必填|
  71 +|--------|----|----|----|--------|
  72 +|id|integer|33|主键|是|
  73 +----------------------------------
  74 +
  75 +### 返回
  76 +
  77 +``` json
  78 +{
  79 + "code": 200,
  80 + "data": {
  81 + "categoryId": "",
  82 + "channel": "1",
  83 + "createTime": 1442310861,
  84 + "id": 33,
  85 + "orderBy": 0,
  86 + "platform": "web",
  87 + "status": 0,
  88 + "tagName": "分类2",
  89 + "updateTime": 0
  90 + },
  91 + "message": "Tag Info"
  92 +}
  93 +```
  94 +
65 # 更新标签接口 95 # 更新标签接口
66 96
67 > 接口名：`hotRankTag/updateTag` 97 > 接口名：`hotRankTag/updateTag`
@@ -12,6 +12,7 @@ @@ -12,6 +12,7 @@
12 |--------|----|----|----|--------| 12 |--------|----|----|----|--------|
13 |title|string|新人|标题，模糊查询|否| 13 |title|string|新人|标题，模糊查询|否|
14 |position|integer|1|位置|否| 14 |position|integer|1|位置|否|
  15 +|showChannel|integer|1|频道, 当位置为首页(2)时，可以选择 1.男首、2.女首、3.潮童、4.创意生活|否|
15 ---------------------------------- 16 ----------------------------------
16 17
17 ### 返回 18 ### 返回
@@ -27,6 +28,7 @@ @@ -27,6 +28,7 @@
27 "id": 15, 28 "id": 15,
28 "img": "", 29 "img": "",
29 "position": 2, 30 "position": 2,
  31 + "showChannels": "1,2,3",
30 "startTime": 1451298061, 32 "startTime": 1451298061,
31 "status": 1, 33 "status": 1,
32 "title": "新人专享", 34 "title": "新人专享",
@@ -53,6 +55,7 @@ @@ -53,6 +55,7 @@
53 |--------|----|----|----|--------| 55 |--------|----|----|----|--------|
54 |title|string|新人|标题，模糊查询|是| 56 |title|string|新人|标题，模糊查询|是|
55 |position|integer|1|位置|是| 57 |position|integer|1|位置|是|
  58 +|showChannels|integer[]|[1,2]|首页频道|否|
56 |url|string|http://test.com|链接|否| 59 |url|string|http://test.com|链接|否|
57 |img|string|http://test.jpg|图片链接|否| 60 |img|string|http://test.jpg|图片链接|否|
58 |startTime|integer|1450843526|开始时间|否| 61 |startTime|integer|1450843526|开始时间|否|
@@ -91,6 +94,7 @@ @@ -91,6 +94,7 @@
91 "id": 22, 94 "id": 22,
92 "img": "http://img.cn.png", 95 "img": "http://img.cn.png",
93 "position": 2, 96 "position": 2,
  97 + "showChannels": "1,2,3",
94 "startTime": 1450843526, 98 "startTime": 1450843526,
95 "status": 0, 99 "status": 0,
96 "title": "这是一个测试", 100 "title": "这是一个测试",
@@ -112,6 +116,7 @@ @@ -112,6 +116,7 @@
112 |id|integer|22|主键|是| 116 |id|integer|22|主键|是|
113 |title|string|新人|标题，模糊查询|是| 117 |title|string|新人|标题，模糊查询|是|
114 |position|integer|1|位置|是| 118 |position|integer|1|位置|是|
  119 +|showChannels|integer[]|[1,2]|首页频道|否|
115 |url|string|http://test.com|链接|否| 120 |url|string|http://test.com|链接|否|
116 |img|string|http://test.jpg|图片链接|否| 121 |img|string|http://test.jpg|图片链接|否|
117 |startTime|integer|1450843526|开始时间|否| 122 |startTime|integer|1450843526|开始时间|否|