接口文档

user

  • 接口一:展示个人信息详细页面

    • GET

    • 传递给后台的参数: phone(String)

    • 传递给客户端的参数:

      • nickname(string),
      • sex(这个后台用的boolean还是String?)
      • crent(信誉度)
      • school(即对应area,String)
      • qianming(String)
      • 是否通过实名认证(Verification)
  • 接口二:修改个人信息页面

    • POST
    • 传递给后台的参数: nickname(String),sex,school,qianming;
    • 后台返回是否修改成功即可;
  • 接口三:实名认证

    • POST
    • 传递给后台的参数:用户姓名name,学号StudentId,统一认证码VerificationNumber,照片img,类型String
  • 接口四:防止登录期间删除APP导致登录不了的情况

    • POST
    • 传递给后台的数据:phone ,password(和登录一致)
    • 如果账号密码正确,则后台删除其登录状态,返回删除结果(boolea,true 删除成功)

首页

  • 接口五:首页展示最新上传的物品即可

    加载物品可以按照分页来,比如刚开始请求是page==1,后面加载更多,page依次增加;

    • GET
    • 传递给后台的:page == 1;
    • 传给客户端的:物品列表,约定一次传递一页(十个或者其他数量),传递过来的信息有:物品名称:name;物品租赁价格:price,物品描述:description ;物品图片:img;物品的唯一表示ID(方便后面的物品收藏上架下架,访问历史等)
  • 接口六:加载更多物品的接口

    • GET
    • 传递给后台的:page(int,依次增加数量);
    • 传递给客户端的:同展示物品;只是物品不一样;
  • 接口七:上架物品

    • POST
    • 传递给后台的:
      • 上传物品的人的phone(将人和物品联系起来,如物品放到该用户的上架列表)
      • 物品的名称name
      • 物品的类型 kinds(我粗略的分成了四种类型:图书音像Books,电子产品ElectronicProducts,生活用品livingGoods,其他物品OtherThings)
      • 物品是出售还是租赁SellOrRent
      • 物品价格price
      • 物品描述description
      • 其他说明
      • 物品图片
    • 返回给客户端的:是否上传成功
  • 接口八:展示物品详情

    • GET
    • 传递给后台的:物品的ID
    • 传递给客户端的:出租物品的人的nickname,物品名称name,物品类型kinds,物品价格price,物品描述description;出租还是租赁SellOrRent;物品图片;其他说明;(即上面提交的信息)
  • 接口九:放到个人信租车

    • PUT
    • 传给后台:用户phone,物品ID
    • 后台将此ID放到该用户的信租车物品列表
  • 接口十:收藏物品,浏览物品列表

    • 基本同上,

先写这些,后面陆续还有

  • 下架物品;
  • 买到的物品
  • 卖出的物品
  • 首页几个分类展示物品

你可能感兴趣的:(接口文档)