瀏覽代碼

添加登陆注册

chenxiqiang 6 年之前
父節點
當前提交
998c538ac0
共有 1 個文件被更改,包括 43 次插入45 次删除
  1. 43
    45
      manage-server/readme.md

+ 43
- 45
manage-server/readme.md 查看文件

@@ -1,7 +1,7 @@
1 1
 # 接口说明
2 2
 ## 通用接口
3 3
 ### 登陆
4
-- `POST/GET /login`
4
+- `POST /api/login`
5 5
 - 参数:
6 6
 
7 7
 参数         |  类型    |   可选  |    备注
@@ -11,25 +11,23 @@ code        |  string  | 	必须  |  小程序code
11 11
 - 响应:
12 12
  
13 13
 ```
14
+//满足UnionID返回条件时,返回的JSON数据包
14 15
 {
15
-	"status": 0,
16
-	"data": {
17
-		"openid": "openid",
18
-		"token": "token",
19
-		"nickname": "nickname",
20
-		"name": "name"
21
-	}
16
+    "openid": "OPENID",
17
+    "session_key": "SESSIONKEY",
18
+    "unionid": "UNIONID"
22 19
 }
23 20
 ```
24 21
 ```
22
+//错误时返回JSON数据包(示例为Code无效)
25 23
 {
26
-	"status": -1,
27
-	"message": "登陆失败!"
24
+	"errcode": 40029,
25
+	"errmsg": "invalid code"
28 26
 }
29 27
 ```
30 28
 
31 29
 ### 上传图片
32
-- `POST /upload`
30
+- `POST /api/upload`
33 31
 - 参数:
34 32
 
35 33
 参数         |  类型    |   可选  |    备注
@@ -58,7 +56,7 @@ photo       |   png/jpeg  | 	必须  |  图片
58 56
 ```
59 57
 
60 58
 ### 添加订单评论
61
-- `POST /${order_type}/${order_id}/comment`
59
+- `POST /api/${order_type}/${order_id}/comment`
62 60
 - 参数:
63 61
 参数         |  类型    |   可选  |    备注
64 62
 ----------- |  ------  |  ------   |  --------
@@ -80,7 +78,7 @@ content     |  string  | 必须       |   评论内容
80 78
 ```
81 79
 
82 80
 ### 分页获取订单评论
83
-- `GET /${order_type}/${order_id}/comments`
81
+- `GET /api/${order_type}/${order_id}/comments`
84 82
 - 参数: 无
85 83
 - 响应:
86 84
 
@@ -112,7 +110,7 @@ content     |  string  | 必须       |   评论内容
112 110
 ```
113 111
 
114 112
 ### 我的订单
115
-- `GET /my/orders`
113
+- `GET /api/my/orders`
116 114
 - 参数:
117 115
 
118 116
 参数         |  类型    |   可选               |    备注
@@ -225,7 +223,7 @@ code        |  string  | 	必须               |  小程序code
225 223
 
226 224
 
227 225
 ### 修改订单状态
228
-- `POST /${order_type}/status`
226
+- `POST /api/${order_type}/status`
229 227
 - 参数:
230 228
 
231 229
 参数         |  类型    |   可选               |    备注
@@ -250,7 +248,7 @@ status      |  integer | 	必须               |  订单状态:0.待处理 1.
250 248
 
251 249
 ## 服务信息接口
252 250
 ### 创建/修改服务信息
253
-- `POST /server/store`
251
+- `POST /api/server/store`
254 252
 - 参数:
255 253
 
256 254
 参数         |  类型    |   可选               |    备注
@@ -276,7 +274,7 @@ content     |  string  | 	必须               |  内容
276 274
 
277 275
 ## 活动接口
278 276
 ### 创建/修改活动
279
-- `POST /campaign/store`
277
+- `POST /api/campaign/store`
280 278
 - 参数:
281 279
 
282 280
 参数         |  类型    |   可选               |    备注
@@ -302,7 +300,7 @@ status      |  integer | 	可选,默认0          |  活动状态:0.进行中,
302 300
 ```
303 301
 
304 302
 ### 删除活动
305
-- `DELETE /campaign/${id}`
303
+- `DELETE /api/campaign/${id}`
306 304
 - 参数:无
307 305
 
308 306
 - 响应:
@@ -322,7 +320,7 @@ status      |  integer | 	可选,默认0          |  活动状态:0.进行中,
322 320
 
323 321
 ### 获得某活动
324 322
 
325
-- `GET /campaign/${id}`
323
+- `GET /api/campaign/${id}`
326 324
 - 参数: 无
327 325
 - 响应:
328 326
 
@@ -341,7 +339,7 @@ status      |  integer | 	可选,默认0          |  活动状态:0.进行中,
341 339
 ```
342 340
 
343 341
 ### 分页查询活动
344
-- `GET /campaigns`
342
+- `GET /api/campaigns`
345 343
 - 参数: 无
346 344
 - 响应:
347 345
 
@@ -373,7 +371,7 @@ status      |  integer | 	可选,默认0          |  活动状态:0.进行中,
373 371
 
374 372
 ## 产品接口
375 373
 ### 创建/修改产品
376
-- `POST /product/store`
374
+- `POST /api/product/store`
377 375
 - 参数:
378 376
 
379 377
 参数         |  类型    |   可选               |    备注
@@ -402,7 +400,7 @@ status      |  integer | 	可选,默认0          |  产品状态:0.上架, 1.
402 400
 ```
403 401
 
404 402
 ### 删除产品
405
-- `DELETE /product/${id}`
403
+- `DELETE /api/product/${id}`
406 404
 - 参数:无
407 405
 - 响应:
408 406
 
@@ -421,7 +419,7 @@ status      |  integer | 	可选,默认0          |  产品状态:0.上架, 1.
421 419
 
422 420
 ### 获得某产品
423 421
 
424
-- `GET /product/${id}`
422
+- `GET /api/product/${id}`
425 423
 - 参数:无
426 424
 - 响应:
427 425
 
@@ -445,7 +443,7 @@ status      |  integer | 	可选,默认0          |  产品状态:0.上架, 1.
445 443
 ```
446 444
 
447 445
 ### 修改产品状态
448
-- `POST /product/status`
446
+- `POST /api/product/status`
449 447
 - 参数:
450 448
 
451 449
 参数         |  类型    |   可选               |    备注
@@ -469,7 +467,7 @@ status      |  integer | 	必须               |  状态:0.上架, 1.下架
469 467
 ```
470 468
 
471 469
 ### 分页查询产品
472
-- `GET /products`
470
+- `GET /api/products`
473 471
 - 参数: 无
474 472
 - 响应:
475 473
 
@@ -506,7 +504,7 @@ status      |  integer | 	必须               |  状态:0.上架, 1.下架
506 504
 
507 505
 ## 家居清洁订单接口
508 506
 ### 创建/修改家居清洁订单
509
-- `POST /house_clean_order/store`
507
+- `POST /api/house_clean_order/store`
510 508
 - 参数:
511 509
 
512 510
 参数         |  类型    |   可选               |    备注
@@ -540,7 +538,7 @@ picture5    | string   |  可选                | 图片链接
540 538
 ```
541 539
 
542 540
 ### 删除订单
543
-- `DELETE /house_clean_order/${id}`
541
+- `DELETE /api/house_clean_order/${id}`
544 542
 - 参数:无
545 543
 
546 544
 - 响应:
@@ -559,7 +557,7 @@ picture5    | string   |  可选                | 图片链接
559 557
 
560 558
 ### 获得某订单
561 559
 
562
-- `GET /house_clean_order/${id}`
560
+- `GET /api/house_clean_order/${id}`
563 561
 - 参数:无
564 562
 
565 563
 - 响应:
@@ -589,7 +587,7 @@ picture5    | string   |  可选                | 图片链接
589 587
 ```
590 588
 
591 589
 ### 分页查询订单
592
-- `GET /house_clean_orders`
590
+- `GET /api/house_clean_orders`
593 591
 - 参数: 无
594 592
 - 响应:
595 593
 
@@ -631,7 +629,7 @@ picture5    | string   |  可选                | 图片链接
631 629
 
632 630
 ## 家电清洁订单接口
633 631
 ### 创建/修改订单
634
-- `POST /house_appliance_clean_order/store`
632
+- `POST /api/house_appliance_clean_order/store`
635 633
 - 参数:
636 634
 
637 635
 参数         |  类型    |   可选               |    备注
@@ -659,7 +657,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
659 657
 ```
660 658
 
661 659
 ### 删除订单
662
-- `DELETE /house_appliance_clean_order/${id}`
660
+- `DELETE /api/house_appliance_clean_order/${id}`
663 661
 - 参数:无
664 662
 
665 663
 - 响应:
@@ -678,7 +676,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
678 676
 
679 677
 ### 获得某订单
680 678
 
681
-- `GET /house_appliance_clean_order/${id}`
679
+- `GET /api/house_appliance_clean_order/${id}`
682 680
 - 参数:无
683 681
 
684 682
 - 响应:
@@ -702,7 +700,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
702 700
 ```
703 701
 
704 702
 ### 分页查询订单
705
-- `GET /house_appliance_clean_orders`
703
+- `GET /api/house_appliance_clean_orders`
706 704
 - 参数: 无
707 705
 - 响应:
708 706
 
@@ -738,7 +736,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
738 736
 
739 737
 ## 保姆订单接口
740 738
 ### 创建/修改订单
741
-- `POST /housekeeper_order/store`
739
+- `POST /api/housekeeper_order/store`
742 740
 - 参数:
743 741
 
744 742
 参数         |  类型    |   可选               |    备注
@@ -770,7 +768,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
770 768
 ```
771 769
 
772 770
 ### 删除订单
773
-- `DELETE /housekeeper_order/${id}`
771
+- `DELETE /api/housekeeper_order/${id}`
774 772
 - 参数:无
775 773
 
776 774
 - 响应:
@@ -789,7 +787,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
789 787
 
790 788
 ### 获得某订单
791 789
 
792
-- `GET /housekeeper_order/${id}`
790
+- `GET /api/housekeeper_order/${id}`
793 791
 - 参数:无
794 792
 
795 793
 - 响应:
@@ -817,7 +815,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
817 815
 ```
818 816
 
819 817
 ### 分页查询订单
820
-- `GET /housekeeper_orders`
818
+- `GET /api/housekeeper_orders`
821 819
 - 参数: 无
822 820
 - 响应:
823 821
 
@@ -857,7 +855,7 @@ status      |  integer | 	可选,默认0          |  订单状态:0.待处理
857 855
 
858 856
 ## 月嫂订单接口
859 857
 ### 创建/修改订单
860
-- `POST /maternity_matron_order/store`
858
+- `POST /api/maternity_matron_order/store`
861 859
 - 参数:
862 860
 
863 861
 参数            |  类型    |   可选               |    备注
@@ -888,7 +886,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
888 886
 ```
889 887
 
890 888
 ### 删除订单
891
-- `DELETE /maternity_matron_order/${id}`
889
+- `DELETE /api/maternity_matron_order/${id}`
892 890
 - 参数:无
893 891
 
894 892
 - 响应:
@@ -907,7 +905,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
907 905
 
908 906
 ### 获得某订单
909 907
 
910
-- `GET /maternity_matron_order/${id}`
908
+- `GET /api/maternity_matron_order/${id}`
911 909
 - 参数:无
912 910
 
913 911
 - 响应:
@@ -934,7 +932,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
934 932
 ```
935 933
 
936 934
 ### 分页查询订单
937
-- `GET /maternity_matron_orders`
935
+- `GET /api/maternity_matron_orders`
938 936
 - 参数: 无
939 937
 - 响应:
940 938
 
@@ -973,7 +971,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
973 971
 
974 972
 ## 产品订单接口
975 973
 ### 创建/修改订单
976
-- `POST /product_order/store`
974
+- `POST /api/product_order/store`
977 975
 - 参数:
978 976
 
979 977
 参数            |  类型    |   可选               |    备注
@@ -1004,7 +1002,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
1004 1002
 ```
1005 1003
 
1006 1004
 ### 删除订单
1007
-- `DELETE /product_order/${id}`
1005
+- `DELETE /api/product_order/${id}`
1008 1006
 - 参数:无
1009 1007
 
1010 1008
 - 响应:
@@ -1023,7 +1021,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
1023 1021
 
1024 1022
 ### 获得某订单
1025 1023
 
1026
-- `GET /product_order/${id}`
1024
+- `GET /api/product_order/${id}`
1027 1025
 - 参数:无
1028 1026
 
1029 1027
 - 响应:
@@ -1052,7 +1050,7 @@ status         |  integer | 	可选,默认0          |  订单状态:0.待处
1052 1050
 ```
1053 1051
 
1054 1052
 ### 分页查询订单
1055
-- `GET /product_orders`
1053
+- `GET /api/product_orders`
1056 1054
 - 参数: 无
1057 1055
 - 响应:
1058 1056
 

Loading…
取消
儲存