appapi

1 说明

1. url命名风格统一为unix编码风格，小写名字和’-‘

2. request和response中都可以包含data块

3. 变量的命名会尽量和后台的数据保持一致，做透传，待调通后，做字段的删减和隐藏

4. 通用request结构

   {
   “platform” : “ios”,
   “platformVersion” : “1.1.1”,
   “deviceModel” : “niubi”,
   “authToken” : “123321”,
   “appVersion” : “1.x.2”,
   “appType” : “seller”,
   “data” : {}
   }

5. 通用response结构

   {
   “code” : 200, // int型, 200默认是成功返回值
   “message” : “”, // 用于客户提示
   “data” : {}
   }

6. 参数类型默认string，否则参照说明，int类型字段的意思参照说明

7. 默认group名和根目录路径一致

2 todo list

1. 返回错误message 转中文
2. response refactor

3. 参数检查refactor

   • 请求参数
   • 返回数据

3 Api list groups

3.1 /version

3.1.1 /check

• 请求参数

  platform: 平台
  platformVersion: 平台版本
  deviceModel: 设备机型

• 返回数据

  appName:
  packageUrl:
  packageName:
  packageSize:
  versionName:
  versionCode:
  createTime:
  needForceUpgrade(bool):

3.2 other

• 根路径: /public/

3.2.1 /category-list

• 请求参数: 无
• 返回数据:

3.2.2 /area-list

• 请求参数: id
• 返回数据:
  

  data: area[]
  area:
  {
  id(int)
  name
  level(int)
  parentId(int)
  postCode
  }

3.2.3 /upload-img (todo)

3.3 home

3.3.1 /index (todo)

• 请求参数:
• 返回数据:

3.4 user

3.4.1 /verification-code

• 请求参数:
  

  mobile: 手机号
  type(int): 请求类型(0:注册, 1:修改密码)

• 返回数据:

3.4.1 /register

• 请求参数:
  

  data: {
  validateCode
  userName
  userPassword
  email (@NotEmpty)
  mobile
  avatar (@NotEmpty )
  regIp
  platform (int :: 0:”未设定”; 1: “Web”; 2: “ios”; 3: “Web”; 4: “h5”)
  }

• 返回数据:

3.4.1 /login

• 请求参数:
  

  data: {
  userName
  userPassword
  }

• 返回数据:
  data: 用户数据
  sample:
  {
  code: 200
  message: “success”
  data: {
  id: 101
  userName: “appdev-1”
  userPassword: “25d55ad283aa400af464c76d713c07ad”
  email: “appdev-1@lianshang.cn”
  mobile: “13800000001”
  ischeckemail: false
  ischeckmobile: false
  avatar: “”
  regIp: “127.0.0.1”
  regTime: 1445937566000
  lastLoginip: “”
  lastLogintime: 31507200000
  platform: 0
  validity: 1
  createId: “sys”
  updateId: “sys”
  createtime: 1445937561000
  userType: 0
  updatetime: 1447065539000
  shopStep: 0
  }-
  token: “55ba99cf34eaafefb5abb6ce07f45f38d748aea068d44569b462d736a8bd7fbb”
  }

3.4.1 /check-token (todo)

3.4.1 /find-password (todo)

3.4.1 /change-password (todo)

3.4.1 /get-info

• 请求参数:
  

  data: {
  userName
  userPassword
  }

• 返回数据: (同login)

3.4.1 /edit-info

• 请求参数:
  

  data: {
  private String realname;
  private int sex; (0: 未设定, 1:男， 2:女, 3:保密)
  private String contactEmail;
  private String contactMobile;
  private String tel;
  private String fax;
  private String qq;
  private String wechat;
  private int countryId;
  private int provinceId;
  private int cityId;
  private int areaId;
  private String address;
  private String zip;
  }

• 返回数据:

3.4.1 /upgrade (todo)

3.5 item

3.5.1 /detail

• 请求参数: id
• 返回数据:
  

  data: item数据透传(做了bean-mapping)

3.5.1 /sku-info

• 请求参数: id
• 返回数据:
  

  data: sku列表

3.6 shop

3.6.1 /info

• 请求参数: id
• 返回数据:
  

  data: shop信息

3.6.1 /extendInfo

• 请求参数: id
• 返回数据:

3.6.1 /item-list

• 请求参数:

  id: 商店id
  pageNo: 翻页no
  pageSize: 每页条目数

• 返回数据:

3.6.1 /company-info

• 
  
• 请求参数: id
• 返回数据:
  

data: company信息

3.7 trade (todo)

3.8 cart (todo)

3.9 pay (todo)

3.10 address

3.11 search(todo)

3.12 message(low priority)