接口文檔

狀態(tài)碼

-1 連接錯(cuò)誤

0 成功

1 異常

4 登陸超時(shí)

1. 首頁(yè)

1.1 接口: /home ? GET

返回
  code: 0,
  data: {
    // 輪播圖
    "banners": [
        "http://localhost:3000/shanghai.jpg"
    ],
    // 熱門(mén)城市
    "hotCitys": [
        {
          "name": "上海",
          "code": "1", // 城市編碼
          "url": "http://localhost:3000/images/home/shanghai.jpg" // 城市圖片
        },
        {
          "name": "北京",
          "code": "2",
          "url": "http://localhost:3000/images/home/beijing.png"
        }
    ]
  }

1.2 獲取城市列表

接口: /getCityList ? GET

  參數(shù)
    pageSize: Number // must
    pageNo: Number // must

1.3

2.資源類(lèi)接口

2.1 獲取熱門(mén)城市

接口：/resource/hotCity ? GET

  {
    "code": 0,
    "data": [
        {
          "name": "上海",
          "code": "1" // 城市編碼
        },
        {
          "name": "北京",
          "code": "2"
        }
    ]
}

2.2 搜索目的地

接口：/resource/search ? POST

  參數(shù)
    name: String, // must

返回
  code: 0,
  data: [
    {
      // 地點(diǎn)名稱(chēng)
      name: '',
      // 地點(diǎn)編碼
      code: ''
    }
  ]

2.3 獲取房源列表

接口：/resource/list ? POST

  參數(shù)
    code: String, // 地區(qū)編碼 Option
    beginTime: 時(shí)間戳, // 入住時(shí)間 Option
    endTime: 時(shí)間戳, // 退房時(shí)間 Option
    minPrice: Number, // 最低價(jià)格 Option
    maxPrice: Number, // 最高價(jià)格 Option
    peoples: Number, // 入住人數(shù) Option
    lease: Number, // 租賃方式 Option
    bedType: Number, // 房間床型 Option
    houseType: Number, // 戶(hù)型 Option
    toilet: Number, // 衛(wèi)生間 Option
    pageNo: Number, // 頁(yè)碼 must
    pageSize: Number, // 頁(yè)數(shù) must
    sort: String, // 排序 must 0 默認(rèn)排序(評(píng)分最高) 1 價(jià)格從高到底  2 價(jià)格從低到高 3 評(píng)分最高 

返回
  code: 0,
  data: [
    {
      houseId: '', // 房源Id
      name: '', // 房屋名稱(chēng)
      images: [], // 圖片
      price: 0, // 價(jià)格
      lease: 1, // 整租|單間
      bedType: 1, // 單人床|雙人床|其他
      houseType: 1, // 一室|二室|三室|四室以上
      buildType: 1, // 公寓|民居|客棧
      toilet: 0, // 獨(dú)立|公共
      peoples: 2, // 宜居人數(shù)
      score: '5.0', // 評(píng)價(jià)
      evaluate: '15', // 評(píng)論數(shù)
      province: '', // 省份
      city: '', // 城市
      region: '', // 地區(qū)
      beginTime: 時(shí)間戳, 入住時(shí)間
      endTime: 時(shí)間戳, 退房時(shí)間
    }
  ]

2.4 獲取房屋詳情

接口：/resource/houseDetail ? GET

  參數(shù)
    houseId: String, // 房源Id must

返回
  code: 0,
  data: {
    // 房屋照片
    banners: [],
    users: {
      // 房主姓名
      name: '',
      // 房主頭像
      avatarUrl: ``,
      // 房主電話(huà)
      phone: ''
    },
    houses: {
      // 面積
      area: 70,
      // 租賃類(lèi)型
      lease: '整租',
      // 房屋類(lèi)型
      buildType: '民居',
      // 房屋格局
      houseType: '2室1廳',
      // 居住人數(shù)
      peoples: '4',
      // 廁所
      toilet: '1',
      // 床位
      bed: '1',
      // 房屋描述
      describe: '',
      // 評(píng)價(jià)
      scores: null,
      // 地址
      addr: '上海浦東新區(qū)',
      // 坐標(biāo)
      coordinate: ['110', '45']
    },
    configure: {
      net: '無(wú)線(xiàn)WIFI',
      tv: '電視',
      shower: '淋浴',
      air: '空調(diào)',
      heating: '暖氣',
      washer: '洗衣機(jī)',
      freezer: '電冰箱',
      hotWater: '全天熱水',
      kitchen: '廚房',
      towel: '毛巾',
      slipper: '拖鞋',
      once: '一次性用品',
      kettle: '熱水壺',
      elevator: '電梯',
      tableware: '餐具炊具',
      blower: '吹風(fēng)機(jī)',
      smartLock: '智能門(mén)鎖',
      cook: '允許做飯'
    },
    notes: {
      // 最早入住時(shí)間
      checkInTime: '',
      // 最晚退房時(shí)間
      checkOutTime: '',
      // 最少入住天數(shù)
      daysToStay: '',
      // 房間編號(hào)
      houseNum: '',
      // 身份證
      idCard: '',
      // 線(xiàn)下押金
      deposit: '',
      // 房東要求
      landlordReq: '',
      // 入住須知
      notice: '',
      // 允許聚餐
      allowDinner: '',
      // 水電費(fèi)
      waterAndEl: '',
      // 額外加床
      extraBed: '',
      // 機(jī)場(chǎng)/火車(chē)站接送
      relay: ''
    }
  }

2.5 獲取房屋評(píng)論

接口：/resource/evaluate ? GET

  參數(shù)
    houseId: String // 房源Id must

2.6 添加房屋評(píng)論

接口：/resource/addEvaluate ? POST

  參數(shù)
    houseId: String, // 房源Id must
    avatarUrl: String, // 用戶(hù)頭像 must
    name: String, // 用戶(hù)昵稱(chēng) must
    content: String, // 評(píng)論內(nèi)容 must
    score: Number // 評(píng)分(最高5分) must

3.賬戶(hù)類(lèi)接口

3.1 小程序登陸

接口: /account/wxlogin ? POST

  參數(shù)
    phone: String, // 手機(jī)號(hào) must
    password: String, // 密碼 must (MD5加密規(guī)則 -> 手機(jī)號(hào) 加上 密碼的加密，然后整個(gè)加密)
    name: String, // 昵稱(chēng) must
    code: String, // 微信code must
    avatarUrl: String, // 用戶(hù)頭像 must

  返回
  code: 0,
  data: {
    userId: '', // 用戶(hù)id
  },
  msg: '登錄成功'

3.2 后臺(tái)登陸

接口: /account/login ? POST

  參數(shù)
    phone: String, // 手機(jī)號(hào) must
    password: String, // 密碼 must (MD5加密規(guī)則 -> 手機(jī)號(hào) 加上 密碼的加密，然后整個(gè)加密)

3.3 修改用戶(hù)信息

接口: /account/modify ? POST

  參數(shù)
    phone: String, // 手機(jī)號(hào) must
    oldPassword: String, // 舊密碼 must
    password: String, // 新密碼 must
    userId: String, // 用戶(hù)Id must

4.文章類(lèi)接口

4.1 獲取文章列表

接口: /discover/wonderful ? GET

  參數(shù)
    pageNo: Number, // 頁(yè)碼 must
    pageSize: Number, // 頁(yè)數(shù) must

4.2 查看文章詳情

接口: /discover/articleDetail ? GET

  參數(shù)
    id: String // 文章id must

4.3 添加文章

接口: /discover/addWonderful ? POST

  參數(shù)
    title: String // 文章標(biāo)題
    content: String // 文章內(nèi)容

4.4 上傳文章封面 TODO

接口: /discover/uploadBanner ? POST

  參數(shù)

5.訂單類(lèi)接口

5.1 生成訂單

接口：/order/generateOrder ? POST

  參數(shù)
    houseId: String, // 房源Id must
    userId: String, // 用戶(hù)Id must
    beginTime: Number, // 入住日期 must
    endTime: Number, // 離開(kāi)日期 must
    name: String, // 房客姓名 option
    phone: String, // 手機(jī)號(hào) must
    totalPrice: Number, // 總價(jià) must

5.2 訂單確認(rèn)支付

接口：/order/confirmPayment ? POST

  參數(shù)
    orderId: String, // 訂單號(hào) must
    totalPrice: Number, // 總價(jià) must

5.3 訂單列表

接口：/order/getOrderList ? POST

  參數(shù)
    status: Number, // 狀態(tài) 0 進(jìn)行中 1 已結(jié)果 must
    userId: String, // 用戶(hù)Id must
    pageSize: Number, // 頁(yè)數(shù) must
    pageNo: Number, // 頁(yè)碼