-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_data.json
503 lines (503 loc) · 16.3 KB
/
api_data.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
[
{
"type": "post",
"url": "/api/geetest_api_v1",
"title": "05.极验配置信息返回",
"name": "geetest_api_v1",
"group": "01Auth",
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"success\": 1,\n \"gt\": \"9af3aa9e204402036ff03ca65b64621a\",\n \"challenge\": \"30d33f3d3cd369458f7831928945f843\",\n \"new_captcha\": 1,\n \"status\": 1\n }",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "post",
"url": "/api/auth/login",
"title": "02.登陆",
"name": "login",
"group": "01Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>M 电子邮箱</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>M 密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_challenge",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_validate",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_seccode",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_status",
"description": "<p>M 极验参数</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"message\": \"\",\n \"status_code\":0\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "错误返回",
"content": "HTTP/1.1 422\n{\n \"message\": \"验证不通过\",\n \"errors\": {\n \"name\": [\"用户名不能为空\"],\n \"email\": [\"邮箱不能为空\"],\n \"password\": [\"密码不能为空\"],\n \"geetest_challenge\": [\"请点击以滑动校验验证码\"],\n \"geetest_validate\": [\"请点击以滑动校验验证码\"],\n \"geetest_seccode\": [\"请点击以滑动校验验证码\"],\n \"geetest_status\": [\"请点击以滑动校验验证码\"]\n },\n \"status_code\": 422\n }\n HTTP/1.1 422（极验验证不通过）\n{\n \"message\": \"验证不通过\",\n \"errors\": {\n \"error\": [\"验证失败请重试\"],\n },\n \"status_code\": 422\n }\nHTTP/1.1 400\n{\n \"message\": \"验证不通过\",\n \"errors\": {\n \"error\": [\"邮箱或密码不正确\"],\n },\n \"status_code\": 400\n }",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "post",
"url": "/api/auth/logout",
"title": "04.退出登陆",
"name": "logout",
"group": "01Auth",
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"message\":\"退出成功\",\n \"status_code\":0\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "get",
"url": "/api/auth/refresh",
"title": "03.刷新token",
"name": "refresh",
"group": "01Auth",
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "post",
"url": "/api/auth/register",
"title": "01.注册",
"name": "register",
"group": "01Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>M 用户名</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>M 电子邮箱</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>M 密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_challenge",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_validate",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_seccode",
"description": "<p>M 极验参数</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "geetest_status",
"description": "<p>M 极验参数</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"message\": \"\",\n \"status_code\":0,\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "错误返回",
"content": "HTTP/1.1 422\n{\n \"message\": \"验证不通过\",\n \"errors\": {\n \"name\": [\"用户名不能为空\"],\n \"email\": [\"邮箱不能为空\"],\n \"password\": [\"密码不能为空\"],\n \"geetest_challenge\": [\"请点击以滑动校验验证码\"],\n \"geetest_validate\": [\"请点击以滑动校验验证码\"],\n \"geetest_seccode\": [\"请点击以滑动校验验证码\"],\n \"geetest_status\": [\"请点击以滑动校验验证码\"]\n },\n \"status_code\": 422\n }",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "get",
"url": "/api/auth/user",
"title": "03.获取用户信息",
"name": "user",
"group": "01Auth",
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"data\":{\n \"id\":1,\n \"name\":\"a\",\n \"email\":\"[email protected]\",\n \"created_at\":\"2018-07-10 02:27:51\",\n \"updated_at\":\"2018-07-10 02:27:51\"\n },\n \"status_code\":0\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "用户接口"
},
{
"type": "get",
"url": "/api/productClassify",
"title": "01.获取商品分类",
"name": "productClassify",
"group": "01ProductClassify",
"success": {
"examples": [
{
"title": "成功返回",
"content": " HTTP/1.1 200\n {\n \"code\": 0,\n \"list\": [\n {\n \"id\": 1,\n \"name\": \"手机\",\n \"pid\": 0,\n \"created_at\": null,\n \"updated_at\": null,\n \"_child\": [\n {\n \"id\": 2,\n \"pid\": 1,\n \"name\": \"魅族手机\",\n \"created_at\": null,\n \"updated_at\": null\n },\n {\n \"id\": 3,\n \"pid\": 1,\n \"name\": \"魅蓝手机\",\n \"created_at\": null,\n \"updated_at\": null\n }\n ]\n },\n ...\n ]\n\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/ProductClassifyController.php",
"groupTitle": "商品分类"
},
{
"type": "post",
"url": "/api/global",
"title": "1.全局返回码",
"description": "<p>全局返回码</p>",
"group": "01Return",
"permission": [
{
"name": "none"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "-1",
"description": "<p>系统错误</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "0",
"description": "<p>请求成功</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "500",
"description": "<p>请求错误</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "422",
"description": "<p>请求参数错误</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "400",
"description": "<p>登陆错误</p>"
}
]
}
},
"version": "0.1.0",
"filename": "app/Http/Controllers/Api/ReturnCodeController.php",
"groupTitle": "全局返回码",
"name": "PostApiGlobal"
},
{
"type": "post",
"url": "Header返回值",
"title": "",
"description": "<p>Header返回值</p>",
"group": "01Return",
"permission": [
{
"name": "none"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>Bearer {token} 登录后返回的token 当token过期后也会返回新的token 需要替换本地token</p>"
}
]
}
},
"version": "0.1.0",
"filename": "app/Http/Controllers/Api/ReturnCodeController.php",
"groupTitle": "全局返回码",
"name": "PostHeader"
},
{
"type": "get",
"url": "/api/addresses",
"title": "01.获取用户地址列表",
"name": "addresses",
"group": "01UserAddresses",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "pSize",
"description": "<p>M 单页显示记录条数（默认10）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "page",
"description": "<p>M 页码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"status_code\": 0,\n \"list\": [\n {\n \"id\": 1,\n \"user_id\": 1,\n \"province\": 11,\n \"city\": 11,\n \"district\": 11,\n \"address\": \"11\",\n \"zip\": 11,\n \"contact_name\": \"1\",\n \"contact_phone\": \"1\",\n \"created_at\": \"2018-07-16 09-18\",\n \"updated_at\": \"2018-07-16 09-18\"\n },\n {\n \"id\": 4,\n \"user_id\": 1,\n \"province\": 2,\n \"city\": 2,\n \"district\": 2,\n \"address\": \"2\",\n \"zip\": 2,\n \"contact_name\": \"2\",\n \"contact_phone\": \"2\",\n \"created_at\": \"2018-07-16 09-18\",\n \"updated_at\": \"2018-07-16 09-18\"\n }\n ],\n \"total\": 2,\n \"totalPage\": 1\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/UserAddressesController.php",
"groupTitle": "用户地址接口"
},
{
"type": "post",
"url": "/api/addresses",
"title": "03.删除用户地址",
"name": "destroy",
"group": "01UserAddresses",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>C 地址ID</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"status_code\": 0,\n \"message\": \"操作成功\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "错误返回",
"content": "HTTP/1.1 200\n{\n \"status_code\": 500,\n \"message\": \"错误信息\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/UserAddressesController.php",
"groupTitle": "用户地址接口"
},
{
"type": "post",
"url": "/api/addresses",
"title": "02.用户地址添加&修改",
"name": "store",
"group": "01UserAddresses",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>C 地址ID（0 => 新增）</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "province",
"description": "<p>M 省份</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "city",
"description": "<p>M 城市</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "district",
"description": "<p>M 区域</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "address",
"description": "<p>M 详细地址</p>"
},
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "zip",
"description": "<p>M 邮编</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "contact_name",
"description": "<p>M 收货人姓名</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "contact_phone",
"description": "<p>M 收货人手机号</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "成功返回",
"content": "HTTP/1.1 200\n{\n \"status_code\": 0,\n \"message\": \"\"\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "错误返回",
"content": "HTTP/1.1 422\n{\n \"message\": \"验证不通过\",\n \"errors\": {\n \"province\": [\"省份不能为空\"],\n \"city\": [\"城市不能为空\"],\n },\n \"status_code\": 422\n }\nHTTP/1.1 500\n{\n \"status_code\": 1,\n \"message\": \"错误信息\"\n}",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/UserAddressesController.php",
"groupTitle": "用户地址接口"
}
]