quintin.zhang / yohobuy-doc · Commits

Go to a project

Authored by chenchao
Commit 2dd30d20259788e4c4c8b912d9d4c6400d48366f 1 parent e9f00634

complete content

Inline Side-by-side
Showing 1 changed file with 85 additions and 60 deletions
1 -# 尺码属性管理接口服务定义 1 +# 品牌款型系列管理接口服务定义
2 --------------------- 2 ---------------------
3 3
4 -# 添加尺码接口 4 +# 添加品牌款型系列接口
5 5
6 -> 接口名： `/product/addSizeAttribute` 6 +> 接口名： `/brandSeries/add`
7 7
8 ### 入参 8 ### 入参
9 9
10 ------------------------- 10 -------------------------
11 |属性名称|类型|例子|说明|是否必填| 11 |属性名称|类型|例子|说明|是否必填|
12 |--------|----|----|----|--------| 12 |--------|----|----|----|--------|
13 -|attributeName|string|后中长|名称|是|  
14 - 13 +|seriesName | string | 羽绒服系列 |名称|是|
  14 +|shopsId | int | 1 | 店铺id | 是|
  15 +|brandId | int | 1 | 店铺id下的某个品牌id | 是|
  16 +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
  17 +|orderBy | int | 1 | 排序值 | 否|
15 --------------------- 18 ---------------------
16 19
17 ### 返回 20 ### 返回
18 21
19 ``` json 22 ``` json
20 { 23 {
21 - "code":200,  
22 - "message":"添加成功！" 24 + "code":200,--若失败为500
  25 + "message":"success"
23 } 26 }
24 27
25 ``` 28 ```
26 29
27 30
28 -# 获取尺码属性列表(有分页) 31 +# 获取品牌款型系列列表(有分页)
29 32
30 -> 接口名： `/product/querySizeAttributeList` 33 +> 接口名： `/brandSeries/queryAll`
31 34
32 ### 入参 35 ### 入参
33 36
34 ------------------------- 37 -------------------------
35 |属性名称|类型|例子|说明|是否必填| 38 |属性名称|类型|例子|说明|是否必填|
36 |-------|----|----|----|-------| 39 |-------|----|----|----|-------|
37 -|curPage|int|1|页码|是|  
38 -|pageSize|int|10|条数|是| 40 +|seriesName | string | 羽绒服系列 |名称|是|
  41 +|shopsId | int | 1 | 店铺id | 是|
  42 +|brandId | int | 1 | 店铺id下的某个品牌id | 是|
  43 +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 是|
39 -------------------------------- 44 --------------------------------
40 45
41 ### 返回 46 ### 返回
42 47
43 ``` json 48 ``` json
44 { 49 {
45 - "code": 200, 50 + "code": 200,--若失败为500
46 "data": { 51 "data": {
47 "list": [ 52 "list": [
48 { 53 {
49 - "attributeName": "衣长",  
50 - "id": 60,  
51 - "orderBy": 0  
52 - },  
53 - {  
54 - "attributeName": "胸底围",  
55 - "id": 61,  
56 - "orderBy": 0  
57 - },  
58 - {  
59 - "attributeName": "防水台",  
60 - "id": 62,  
61 - "orderBy": 1  
62 - },  
63 - {  
64 - "attributeName": "品牌尺寸",  
65 - "id": 63,  
66 - "orderBy": 1  
67 - },  
68 - {  
69 - "attributeName": "半径",  
70 - "id": 64,  
71 - "orderBy": 1 54 + "brandId": 5,
  55 + "id": 48,
  56 + "seriesName": "test-cc-u",
  57 + "shopsId": 5,
  58 + "status": 1,
  59 + "type": 5
72 } 60 }
73 ], 61 ],
74 "page": 0,-第几页 62 "page": 0,-第几页
@@ -77,15 +65,15 @@ @@ -77,15 +65,15 @@
77 "totalPage": 1--总页数 65 "totalPage": 1--总页数
78 }, 66 },
79 "md5": "81531967e3291781f608555ca63ccd28", 67 "md5": "81531967e3291781f608555ca63ccd28",
80 - "message": "Product size List." 68 + "message": "success"
81 } 69 }
82 70
83 ``` 71 ```
84 72
85 73
86 -# 更新尺码属性接口 74 +# 更新品牌款型系列接口
87 75
88 -> 接口名： `/product/updateSizeAttribute` 76 +> 接口名： `/brandSeries/update`
89 77
90 ### 入参 78 ### 入参
91 79
@@ -93,77 +81,114 @@ @@ -93,77 +81,114 @@
93 |属性名称|类型|例子|说明|是否必填| 81 |属性名称|类型|例子|说明|是否必填|
94 |--------|----|----|----|--------| 82 |--------|----|----|----|--------|
95 |id|int|15|ID|是| 83 |id|int|15|ID|是|
96 -|attributeName|string|后中长|名称|是| 84 +|seriesName | string | 羽绒服系列 |名称|否|
  85 +|shopsId | int | 1 | 店铺id | 否|
  86 +|brandId | int | 1 | 店铺id下的某个品牌id | 否|
  87 +|type | int | 1 | 1:"品牌款型";2:"品牌系列" | 否|
  88 +|orderBy | int | 1 | 排序值 | 否|
97 --------------------- 89 ---------------------
98 90
99 ### 返回 91 ### 返回
100 92
101 ``` json 93 ``` json
102 { 94 {
103 - "code": 200, 95 + "code": 200,--若失败为500
104 "data": [], 96 "data": [],
105 "md5": "d751713988987e9331980363e24189ce", 97 "md5": "d751713988987e9331980363e24189ce",
106 - "message": "size update success." 98 + "message": "success"
107 } 99 }
108 100
109 ``` 101 ```
110 102
111 103
112 104
113 -# 获取单个尺码属性接口 105 +# 获取单个品牌款型系列接口
  106 +
  107 +> 接口名： `/brandSeries/queryById/{id}`
114 108
115 -> 接口名： `/product/getSizeAttribute` 109 +{id} 具体的品牌款型系列id值,数据类型：int
  110 +例：/brandSeries/queryById/14
  111 +
  112 +http method : get & post all ok;
116 113
117 ### 入参 114 ### 入参
118 115
119 ------------------------- 116 -------------------------
120 |属性名称|类型|例子|说明|是否必填| 117 |属性名称|类型|例子|说明|是否必填|
121 |--------|----|----|----|--------| 118 |--------|----|----|----|--------|
122 -|id |int |15 |ID |是| 119 +
123 --------------------- 120 ---------------------
124 121
125 ### 返回 122 ### 返回
126 123
127 ``` json 124 ``` json
128 { 125 {
129 - "code": 200, 126 + "code": 200,--若失败为500
130 "data":{ 127 "data":{
131 - "attributeName": "半径",  
132 - "id": 64,  
133 - "orderBy": 1 128 + "brandId": 286,
  129 + "id": 13,
  130 + "orderBy": 4,
  131 + "parentId": 0,
  132 + "seriesName": "Mikio Sakabe",
  133 + "shopsId": 1,
  134 + "status": 1
134 }, 135 },
135 "md5": "dfc645ecb0c66c8d4771dd2a749047e8", 136 "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
136 - "message": "Product size get success." 137 + "message": "success"
137 } 138 }
138 139
139 ``` 140 ```
140 141
141 -# 根据名称模糊查询获取一组尺码属性接口 142 +# 打开品牌款型系列接口
  143 +
  144 +> 接口名： `/brandSeries/open/{id}`
142 145
143 -> 接口名： `/product/querySizeAttributesByName` 146 +{id} 具体的品牌款型系列id值,数据类型：int
  147 +例：/brandSeries/open/14
144 148
145 ### 入参 149 ### 入参
146 150
147 ------------------------- 151 -------------------------
148 |属性名称|类型|例子|说明|是否必填| 152 |属性名称|类型|例子|说明|是否必填|
149 |--------|----|----|----|--------| 153 |--------|----|----|----|--------|
150 -|idName |String |长 |属性名称中包含的字词 |是| 154 +
151 --------------------- 155 ---------------------
152 156
153 ### 返回 157 ### 返回
154 158
155 ``` json 159 ``` json
156 { 160 {
157 - "code": 200,  
158 - "data": [  
159 - {  
160 - "text": "衣长",  
161 - "id": 60 161 + "code": 200,--若失败为500
  162 + "data": [],
  163 + "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
  164 + "message": "success"
  165 +}
162 166
163 - }  
164 - ], 167 +```
  168 +
  169 +# 关闭品牌款型系列接口（restfull 风格）
  170 +
  171 +> 接口名： `/brandSeries/close/{id}`
  172 +
  173 +{id} 具体的品牌款型系列id值,数据类型：int
  174 +例：/brandSeries/close/14
  175 +
  176 +### 入参
  177 +
  178 +-------------------------
  179 +|属性名称|类型|例子|说明|是否必填|
  180 +|--------|----|----|----|--------|
  181 +
  182 +---------------------
  183 +
  184 +### 返回
  185 +
  186 +``` json
  187 +{
  188 + "code": 200,--若失败为500
  189 + "data": [ ],
165 "md5": "dfc645ecb0c66c8d4771dd2a749047e8", 190 "md5": "dfc645ecb0c66c8d4771dd2a749047e8",
166 - "message": "Product size get success." 191 + "message": "success"
167 } 192 }
168 193
169 ``` 194 ```