Showing
1 changed file
with
175 additions
and
0 deletions
inferface-document/guang/articleTag.md
0 → 100644
1 | +标签管理接口服务定义 | ||
2 | +--------------------- | ||
3 | + | ||
4 | + | ||
5 | + | ||
6 | +## 标签列表查询 | ||
7 | + | ||
8 | +> 接口名: '/guang/tags/getList' | ||
9 | + | ||
10 | +### 入参 | ||
11 | + | ||
12 | +------------------------- | ||
13 | +|属性名称|类型|例子|说明| | ||
14 | +|--------|----|----|----| | ||
15 | +|tagName|String|运动|标签名称| | ||
16 | +|classifyId|int|1|分类名称| | ||
17 | +|isHot|int|1|是否热门| | ||
18 | +--------------------- | ||
19 | + | ||
20 | +### 返回 | ||
21 | + | ||
22 | +``` json | ||
23 | +{ | ||
24 | + "code":200, | ||
25 | + "message":"操作成功", | ||
26 | + "data": { | ||
27 | + "list": [ | ||
28 | + { | ||
29 | + "id": "1", //标签ID | ||
30 | + "tagName": "运动", //标签名称 | ||
31 | + "classifyId": "2", //分类ID | ||
32 | + "isHot": "1", //是否热门,0非热门,1热门 | ||
33 | + "status": "1", //状态,0关闭,1开启 | ||
34 | + "createTime": "1432113792"//创建时间 | ||
35 | + } | ||
36 | + ] | ||
37 | + } | ||
38 | +} | ||
39 | + | ||
40 | +``` | ||
41 | + | ||
42 | + | ||
43 | +## 添加标签接口 | ||
44 | + | ||
45 | +> 接口名: '/guang/tags/addTag' | ||
46 | + | ||
47 | +### 入参 | ||
48 | + | ||
49 | +------------------------- | ||
50 | +|属性名称|类型|例子|说明| | ||
51 | +|--------|----|----|----| | ||
52 | +|tagName|String|运动|标签名称| | ||
53 | +|classifyId|int|1|分类ID| | ||
54 | +|isHot|int|1|是否热门| | ||
55 | +|status|int|1|是否启用| | ||
56 | +--------------------- | ||
57 | + | ||
58 | +### 返回 | ||
59 | + | ||
60 | +``` json | ||
61 | +{ | ||
62 | + "code":200, | ||
63 | + "message":"添加成功!" | ||
64 | +} | ||
65 | + | ||
66 | +``` | ||
67 | + | ||
68 | + | ||
69 | +## 编辑标签接口 | ||
70 | + | ||
71 | +> 接口名: '/guang/tags/updateTag' | ||
72 | + | ||
73 | +### 入参 | ||
74 | + | ||
75 | +------------------------- | ||
76 | +|属性名称|类型|例子|说明| | ||
77 | +|--------|----|----|----| | ||
78 | +|id|int|1|标签ID| | ||
79 | +|tagName|String|运动|标签名称| | ||
80 | +|classifyId|int|1|分类ID| | ||
81 | +|isHot|int|1|是否热门| | ||
82 | +|status|int|1|是否启用| | ||
83 | +--------------------- | ||
84 | + | ||
85 | +### 返回 | ||
86 | + | ||
87 | +``` json | ||
88 | +{ | ||
89 | + "code":200, | ||
90 | + "message":"修改成功!" | ||
91 | +} | ||
92 | + | ||
93 | +``` | ||
94 | + | ||
95 | +## 编辑时标签详情接口 | ||
96 | + | ||
97 | +> 接口名: '/guang/tags/getDetail' | ||
98 | + | ||
99 | +### 入参 | ||
100 | + | ||
101 | +------------------------- | ||
102 | +|属性名称|类型|例子|说明| | ||
103 | +|--------|----|----|----| | ||
104 | +|id|int|1|标签id| | ||
105 | +--------------------- | ||
106 | + | ||
107 | +### 返回 | ||
108 | + | ||
109 | +``` json | ||
110 | +{ | ||
111 | + "code":200, | ||
112 | + "message":"操作成功", | ||
113 | + "data": { | ||
114 | + "id": "1", //标签ID | ||
115 | + "tagName": "运动", //标签名称 | ||
116 | + "classifyId": "2", //分类ID | ||
117 | + "isHot": "1", //是否热门,0非热门,1热门 | ||
118 | + "status": "1", //状态,0关闭,1开启 | ||
119 | + "createTime": "1432113792"//创建时间 | ||
120 | + } | ||
121 | +} | ||
122 | + | ||
123 | +``` | ||
124 | + | ||
125 | + | ||
126 | +## 删除标签接口 | ||
127 | + | ||
128 | +> 接口名: '/guang/tags/delTag' | ||
129 | + | ||
130 | +### 入参 | ||
131 | + | ||
132 | +------------------------- | ||
133 | +|属性名称|类型|例子|说明| | ||
134 | +|--------|----|----|----| | ||
135 | +|id|int|1|标签id| | ||
136 | +--------------------- | ||
137 | + | ||
138 | +### 返回 | ||
139 | + | ||
140 | +``` json | ||
141 | +{ | ||
142 | + "code":200, | ||
143 | + "message":"删除成功!" | ||
144 | +} | ||
145 | + | ||
146 | +``` | ||
147 | + | ||
148 | +## 新增或编辑时获取标签分类列表 | ||
149 | + | ||
150 | +> 接口名: '/guang/tagSort/getTagItems' | ||
151 | + | ||
152 | +### 入参 | ||
153 | + | ||
154 | +------------------------- | ||
155 | +|属性名称|类型|例子|说明| | ||
156 | +|--------|----|----|----| | ||
157 | +|status|int|1|开启状态的分类| | ||
158 | +--------------------- | ||
159 | + | ||
160 | +### 返回 | ||
161 | + | ||
162 | +``` json | ||
163 | +{ | ||
164 | + "code":200, | ||
165 | + "message":"操作成功", | ||
166 | + "data": [ | ||
167 | + { | ||
168 | + "id": "1", | ||
169 | + "text":"搭配风格" | ||
170 | + } | ||
171 | + ] | ||
172 | + | ||
173 | +} | ||
174 | + | ||
175 | +``` |
-
Please register or login to post a comment