Browse Source

chore[litemall-wx, litemall-wx-api]: 收货地址API调整及文档

Junling Bu 6 years ago
parent
commit
2b70ceb108

+ 108 - 10
doc/api.md

@@ -689,7 +689,7 @@ API应该存在版本控制,以保证兼容性。
 
 应用场景
 
-    请求用户收货地址列表
+    用户收货地址列表
 
 接口链接
 
@@ -698,19 +698,41 @@ API应该存在版本控制,以保证兼容性。
 请求参数
 
     userId: 用户ID
-    
+    page: 请求页码
+    limit: 每一页数量
+    sort: 排序字段
+    order: 升序降序
+        
 响应结果
 
     {
-        errno: 0,
-        errmsg: "成功",,
-        list: [AddressVo]
-        page:  xx
-        limit: xx
-        total: xx
+      "errno": 0,
+      "data": {
+        "total": 1,
+        "pages": 1,
+        "limit": 1,
+        "page": 1,
+        "list": [
+          {
+            "id": 3,
+            "name": "d",
+            "userId": 2,
+            "province": "北京市",
+            "city": "市辖区",
+            "county": "东城区",
+            "addressDetail": "ddd",
+            "areaCode": "110101",
+            "tel": "13811111111",
+            "isDefault": true,
+            "addTime": "2019-05-06 14:17:32",
+            "updateTime": "2019-05-06 14:17:32",
+            "deleted": false
+          }
+        ]
+      },
+      "errmsg": "成功"
     }
 
-
 错误码
 
@@ -752,7 +774,83 @@ API应该存在版本控制,以保证兼容性。
 错误码
 
-    	
+
+    
+#### 2.8.3 保存收货地址
+
+应用场景
+
+    添加或者更新用户收货地址
+
+接口链接
+
+    POST /wx/address/save
+
+请求参数
+
+    id: 收货地址ID,如果是0则是添加,否则是更新
+    name: 收货人,
+    tel: 手机号
+    province: 省级行政区域,
+    city: 市级行政区域,
+    county: 区级行政区域,
+    addressDetail: 具体地址,
+    areaCode: 地址编码,
+    postalCode: 邮政编码
+    isDefault: 是否默认    
+
+例如
+    
+    {
+      "id": 0,
+      "name": "xxx",
+      "tel": "13811111111",
+      "province": "北京市",
+      "city": "市辖区",
+      "county": "东城区",
+      "areaCode": "110101",
+      "addressDetail": "dddd",
+      "isDefault": true
+    }
+    
+响应结果
+
+    {
+        errno: 0,
+        errmsg: "成功",,
+        data: 3
+    }
+
+错误码
+
+    略
+    
+    
+#### 2.8.4 删除收货地址
+
+应用场景
+
+    删除用户的某个收货地址
+
+接口链接
+
+    POST /wx/address/delete
+
+请求参数
+
+    id: 收货地址ID
+    
+响应结果
+
+    {
+        errno: 0,
+        errmsg: "成功"
+    }
+
+错误码
+
+    略
+            	
 ### 2.9 品牌商服务
 
 #### 2.9.1 品牌商列表

+ 1 - 1
litemall-wx-api/src/main/java/org/linlinjava/litemall/wx/web/WxAddressController.java

@@ -45,7 +45,7 @@ public class WxAddressController extends GetRegionService {
 			return ResponseUtil.unlogin();
 		}
 		List<LitemallAddress> addressList = addressService.queryByUid(userId);
-		return ResponseUtil.ok(addressList);
+		return ResponseUtil.okList(addressList);
 	}
 
 	/**

+ 3 - 1
litemall-wx/pages/ucenter/address/address.js

@@ -5,6 +5,7 @@ var app = getApp();
 Page({
   data: {
     addressList: [],
+    total: 0
   },
   onLoad: function(options) {
     // 页面初始化 options为页面跳转所带来的参数
@@ -21,7 +22,8 @@ Page({
     util.request(api.AddressList).then(function(res) {
       if (res.errno === 0) {
         that.setData({
-          addressList: res.data
+          addressList: res.data.list,
+          total: res.data.total
         });
       }
     });

+ 1 - 1
renard-wx/pages/ucenter/address/address.js

@@ -29,7 +29,7 @@ Page({
     util.request(api.AddressList).then(function(res) {
       if (res.errno === 0) {
         that.setData({
-          addressList: res.data
+          addressList: res.data.list
         });
       }
     });