lingmin / yohobuy-doc · Commits

Go to a project

Authored by lingmin
Commit b53d518f83edcf20602662152b09220e8e2997e7 1 parent 0c8f1674

相关接口定义

Inline Side-by-side
Showing 1 changed file with 147 additions and 177 deletions
1 -# 活动模板接口服务定义  
2 ----------------------- 1 +**1、获取支付管理列表**
3 2
4 -# 查询模板列表接口 3 + 获取支付管理列表（/PayManageController/findPayManageList）
5 4
6 -> 接口名：`activityTemplate/selectTemplateList` 5 +**请求参数**
7 6
8 -### 入参 7 +无
9 8
10 -----------------------------------  
11 -|属性名称|类型|例子|说明|是否必填|  
12 -|--------|----|----|----|--------|  
13 -|status|integer|1|状态：0 不启用 ，1 启用 |否|  
14 ----------------------------------- 9 +**请求示例**
15 10
16 -### 返回 11 +注意，通用的头部没有列出
17 12
18 -``` json  
19 -{  
20 - "code":200,  
21 - "message":"请求成功",  
22 - "data": [  
23 - {  
24 - "createTime": 1453966206,  
25 - "id": 1,  
26 - "image": "", // 图片链接  
27 - "shareId": 0,  
28 - "status": 1, // 0 不启用 ，1 启用  
29 - "title": "",  
30 - "url": ""  
31 - }  
32 - ]  
33 -}  
34 -```  
35 -  
36 -# 添加模板接口 13 +http://localhost:8080/platform/PayManageController/findPayManageList
37 14
38 -> 接口名：`activityTemplate/addTemplate`  
39 15
40 -### 入参 16 +**响应**
41 17
42 -----------------------------------  
43 -|属性名称|类型|例子|说明|是否必填|  
44 -|--------|----|----|----|--------|  
45 -|title|string|新人专享活动模板|模板标题|是|  
46 -|image|string|http://yoho.cn/18282.jpg|图片地址|否|  
47 -|url|string|http://yoho.cn/18282.template|模板地址|否|  
48 -|shareId|integer|1|共享ID|否|  
49 ----------------------------------- 18 +code为200即为成功，否则是失败。 响应JSON格式如下所示:
50 19
51 -### 返回  
52 -  
53 -``` json  
54 -{  
55 - "code":200,  
56 - "message":"添加成功！"  
57 -}  
58 -``` 20 + {
  21 + "code": 200,
  22 + "data":{
  23 + "currentPage":1
  24 + "rows":[{"id": 2,
  25 + "payName": "支付宝",
  26 + "recommendOrderPage":1,
  27 + "recommendWords":"",
  28 + "sortNumber":2,
  29 + "recommendText1":"",
  30 + "recommendText2":"",
  31 + "status":1,
  32 + "createTime":"";
  33 + "updateTime":""},{
  34 + "id": 3,
  35 + "payName": "微信",
  36 + "recommendOrderPage":1,
  37 + "recommendWords":"",
  38 + "sortNumber":1,
  39 + "recommendText1":"",
  40 + "recommendText2":"",
  41 + "status":1,
  42 + "createTime":"";
  43 + "updateTime":""}],
  44 + "pageSize":10,
  45 + "total":10,
  46 + "totalPage":1
  47 + },
  48 + "md5": "d751713988987e9331980363e24189ce",
  49 + "message": "操作成功"
  50 + }
59 51
60 -# 更新模板接口  
61 52
62 -> 接口名：`activityTemplate/updateTeplate` 53 +**2、获取支付方式详情**
63 54
64 -### 入参 55 +获取支付方式详情(/PayManageController/findPayInfoById)
65 56
66 -----------------------------------  
67 -|属性名称|类型|例子|说明|是否必填|  
68 -|--------|----|----|----|--------|  
69 -|id|integer|1|主键|是|  
70 -|title|string|新人专享活动模板|模板标题|是|  
71 -|image|string|http://yoho.cn/18282.jpg|图片地址|否|  
72 -|url|string|http://yoho.cn/18282.template|模板地址|否|  
73 -|shareId|integer|1|共享ID|否|  
74 ----------------------------------- 57 +**请求参数**
75 58
76 -### 返回 59 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  60 +| ---------|:--------:| --------:|-----:|------:|-----:|
  61 +|id |int | 否 |1 | | |
77 62
78 -``` json  
79 -{  
80 - "code":200,  
81 - "message":"添加成功！"  
82 -}  
83 -```  
84 63
85 -# 开启模板接口 64 +**请求示例**
86 65
87 -> 接口名：`activityTemplate/publishTemplate` 66 +注意，通用的头部没有列出
88 67
89 -### 入参 68 +http://localhost:8080/platform/PayManageController/findPayInfoById
90 69
91 -----------------------------------  
92 -|属性名称|类型|例子|说明|是否必填|  
93 -|--------|----|----|----|--------|  
94 -|id|integer|1|主键|是|  
95 ----------------------------------- 70 + {
  71 + "id":2
  72 + }
96 73
97 -### 返回  
98 74
99 -``` json  
100 -{  
101 - "code":200,  
102 - "message":"操作成功！"  
103 -}  
104 -``` 75 +**响应**
105 76
106 -# 关闭模板接口 77 + {
  78 + "code": 200,
  79 + "data": {
  80 + "id": 2,
  81 + "payName": "支付宝",
  82 + "recommendOrderPage":1,
  83 + "recommendWords":"",
  84 + "sortNumber":2,
  85 + "recommendText1":"",
  86 + "recommendText2":"",
  87 + "status":1,
  88 + "createTime":"";
  89 + "updateTime":""
  90 + },
  91 + "md5": "d751713988987e9331980363e24189ce",
  92 + "message": "操作成功"
  93 + }
107 94
108 -> 接口名：`activityTemplate/closeTemplate` 95 +**3、新增支付方式**
109 96
110 -### 入参 97 +新增支付方式（/PayManageController/createPayMode）
111 98
112 -----------------------------------  
113 -|属性名称|类型|例子|说明|是否必填|  
114 -|--------|----|----|----|--------|  
115 -|id|integer|1|主键|是|  
116 ----------------------------------- 99 +**请求参数**
117 100
118 -### 返回 101 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  102 +| ---------|:--------:| --------:|-----:|------:|-----:|
  103 +|payName |String | 否 |支付宝 | | 支付方式名称 |
  104 +|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否；1-是|
  105 +|recommendWords |String | 是 | | | 推荐文案 |
  106 +|sortNumber |int | 否 |1 | 0 | 前端排序值，数字越大越靠前 |
  107 +|recommendText1 |String | 是 | | |推荐语1 |
  108 +|recommendText2 |String | 是 | | | 推荐语2 |
119 109
120 -``` json  
121 -{  
122 - "code":200,  
123 - "message":"操作成功！"  
124 -}  
125 -```  
126 110
127 -# 根据条件查询活动商品列表接口 111 +**请求示例**
128 112
129 -> 接口名：`activityTemplate/getProductListByCondition` 113 +注意，通用的头部没有列出
130 114
131 -### 入参 115 +http://localhost:8080/platform/PayManageController/createPayMode
132 116
133 -----------------------------------  
134 -|属性名称|类型|例子|说明|是否必填|  
135 -|--------|----|----|----|--------|  
136 -|templateId|integer|1|模板ID|是|  
137 -|productSkn|integer|1|商品SKN|否|  
138 ----------------------------------- 117 + {
  118 + "payName":"支付宝",
  119 + "recommendOrderPage":1,
  120 + "recommendWords":"推荐文案",
  121 + "sortNumber":2,
  122 + "recommendText1":""
  123 + }
139 124
140 -### 返回 125 +**响应**
141 126
142 -``` json  
143 -{  
144 - "code": 200,  
145 - "data": {  
146 - "list": [  
147 { 127 {
148 - "id": 1,  
149 - "isRecommend": true,  
150 - "orderBy": 110,  
151 - "productSkn": 51125277,  
152 - "status": 1,  
153 - "templateId": 2 128 + "code": 200,
  129 + "data": {},
  130 + "md5": "d751713988987e9331980363e24189ce",
  131 + "message": "操作成功"
154 } 132 }
155 - ],  
156 - "page": 1,  
157 - "size": 10,  
158 - "total": 1,  
159 - "totalPage": 1  
160 - },  
161 - "message": "Temp SKN list"  
162 -}  
163 -```  
164 133
165 -# 插入活动商品信息接口  
166 134
167 -> 接口名：`activityTemplate/insertProduct` 135 +**4、编辑支付方式详情**
168 136
169 -### 入参 137 +编辑支付方式(/PayManageController/updatePayInfoById)
170 138
171 -----------------------------------  
172 -|属性名称|类型|例子|说明|是否必填|  
173 -|--------|----|----|----|--------|  
174 -|templateId|integer|1|模板ID|是|  
175 -|productSkn|integer|1|商品SKN|是|  
176 ----------------------------------- 139 +**请求参数**
177 140
178 -### 返回  
179 -  
180 -``` json  
181 -{  
182 - "code": 200,  
183 - "message": "添加成功",  
184 -}  
185 -``` 141 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  142 +| ---------|:--------:| --------:|-----:|------:|-----:|
  143 +|id |int | 否 |1 | | |
  144 +|payName |String | 否 |支付宝 | | 支付方式名称，不可修改 |
  145 +|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否；1-是|
  146 +|recommendWords |String | 是 | | | 推荐文案 |
  147 +|sortNumber |int | 否 |1 | 0 | 前端排序值，数字越大越靠前 |
  148 +|recommendText1 |String | 是 | | |推荐语1 |
  149 +|recommendText2 |String | 是 | | | 推荐语2 |
186 150
187 151
188 -# 更新商品信息接口 152 +**请求示例**
189 153
190 -> 接口名：`activityTemplate/updateProduct` 154 +注意，通用的头部没有列出
191 155
192 -### 入参 156 +http://localhost:8080/platform/PayManageController/updatePayInfoById
193 157
194 -----------------------------------  
195 -|属性名称|类型|例子|说明|是否必填|  
196 -|--------|----|----|----|--------|  
197 -|id|integer|1|商品ID|是|  
198 -|orderBy|integer|1|排序号|否|  
199 -|isRecommend|integer|1|是否推荐|否|  
200 -|status|integer|1|是否启用|否|  
201 ----------------------------------- 158 + {
  159 + "id":2,
  160 + "recommendOrderPage":1,
  161 + "recommendWords":"推荐文案",
  162 + "sortNumber":2
  163 + }
202 164
203 -### 返回 165 +**响应**
204 166
205 -``` json  
206 -{ 167 + {
207 "code": 200, 168 "code": 200,
208 - "message": "操作成功",  
209 -}  
210 -``` 169 + "data": {},
  170 + "md5": "d751713988987e9331980363e24189ce",
  171 + "message": "操作成功"
  172 + }
211 173
212 -# 删除商品信息接口  
213 174
214 -> 接口名：`activityTemplate/delOneProduct` 175 +**5、关闭/开启支付方式**
215 176
216 -### 入参 177 +关闭/开启支付方式(/PayManageController/offOrOnPayModeById)
217 178
218 -----------------------------------  
219 -|属性名称|类型|例子|说明|是否必填|  
220 -|--------|----|----|----|--------|  
221 -|id|integer|1|主键|是|  
222 ----------------------------------- 179 + **请求参数**
223 180
224 -### 返回 181 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  182 +| ---------|:--------:| --------:|-----:|------:|-----:|
  183 +|id |int | 否 |1 | | |
  184 +|status |int | 否 |1 | | 0-关闭，1-开启 |
225 185
226 -如果删除失败，可能是没有删除权限。 186 +**请求示例**
227 187
228 -``` json  
229 -{  
230 - "code":200,  
231 - "message":"操作成功！"  
232 -}  
233 -``` 188 +注意，通用的头部没有列出
234 189
  190 +http://localhost:8080/platform/PayManageController/offOrOnPayModeById
  191 +
  192 + {
  193 + "id":2,
  194 + "status":1
  195 + }
  196 +
  197 +**响应**
  198 +
  199 + {
  200 + "code": 200,
  201 + "data": {},
  202 + "md5": "d751713988987e9331980363e24189ce",
  203 + "message": "操作成功"
  204 + }