iHome 接口文档 - 图1

4、首页相关

4.1、web服务

简要描述：
• 网站web页面显示与路由解析 请求URL：
http://127.0.0.1:8080

路由列表：

服务编号 服务名称 请求类型 url 调用函数
1 web服务 /
2 获取地区信息服务 GET api/v1.0/areas GetArea
3 获取验证码图片服务 GET api/v1.0/imagecode/:uuid GetImageCd
4 获取短信验证码服务 GET api/v1.0/smscode/:mobile GetSmscd
5 发送注册信息服务 POST api/v1.0/users PostRet
6 获取session信息服务 GET api/v1.0/session GetSession
7 发送登陆信息服务 POST api/v1.0/sessions PostLogin
8 删除（退出）登陆信息服务 DELETE api/v1.0/session DeleteSession
9 获取用户基本信息服务 GET api/v1.0/user GetUserInfo
10 发送（上传）用户头像服务 POST api/v1.0/user/avatar PostAvatar
11 更新用户名服务 PUT api/v1.0/user/name PutUserInfo
12 获取（检查）用户实名信息服务 GET api/v1.0/user/auth GetUserAuth
13 发送用户实名认证信息服务 POST api/v1.0/user/auth PostUserAuth
14 获取用户已发布房源信息服务 GET api/v1.0/user/houses GetUserHouses
15 发送（发布）房源信息服务 POST api/v1.0/houses PostHouses
16 发送（上传）房屋图片服务 POST api/v1.0/houses/:id/images PostHousesImage
17 获取房屋详细信息服务 GET api/v1.0/houses/:id GetHouseInfo
18 获取首页轮播图片服务 GET api/v1.0/house/index GetIndex
19 获取（搜索）房源服务 GET api/v1.0/houses GetHouses
20 发送（发布）订单服务 POST api/v1.0/orders PostOrders
21 获取房东/租户订单信息服务 GET api/v1.0/user/orders GetUserOrder
22 更新房东同意/拒绝订单 PUT api/v1.0/orders/:id/status PutOrders
23 更新用户评价订单信息 PUT api/v1.0/orders/:id/comment PutComment

备注：分清请求类型与参数

4.2、获取地区信息服务

简要描述： 获取相关地域信息
请求URL： http://xx.com/api/v1.0/areas
请求方式：GET
参数： 无
返回成功

  1. {
  2.     "errno": 0,
  3.     "errmsg":"OK",
  4.     "data": [
  5.     {"aid": 1, "aname": "东城区"}, 
  6.     {"aid": 2, "aname": "西城区"}, 
  7.     {"aid": 3, "aname": "通州区"}, 
  8.     {"aid": 4, "aname": "顺义区"}] 
  9. }

返回失败

  1. {
  2.     "errno": "4001",     //状态码
  3.     "errmsg":"状态错误信息"  //状态信息
  4. }

返回参数说明
参数名 类型 说明
errno string 状态码
errmsg string 状态信息
data 切片 地域信息
aid int32（int） 地域编号
aname string 地域名

备注 返回给前端与proto是不一样的

4.3、获取首页轮播图片服务

简要描述： 获取首页轮播图以及相关房屋图片
请求URL： http://xx.com/api/v1.0/house/index
请求方式：GET
参数： 无
返回成功

  1. {
  2.   "errno": "0",
  3.   "errmsg": "成功",
  4.   "data": {
  5.         "houses": [
  6.       {
  7.         "house_id":    this.Id,
  8.         "title":       this.Title,
  9.         "price":       this.Price,
  10.         "area_name":   this.Area.Name,
  11.         "img_url":     utils.AddDomain2Url(this.Index_image_url),
  12.         "room_count":  this.Room_count,
  13.         "order_count": this.Order_count,
  14.         "address":     this.Address,
  15.         "user_avatar": utils.AddDomain2Url(this.User.Avatar_url),
  16.         "ctime":       this.Ctime.Format("2006-01-02 15:04:05"),
  17.     },
  18.       {
  19.         "house_id":    this.Id,
  20.         "title":       this.Title,
  21.         "price":       this.Price,
  22.         "area_name":   this.Area.Name,
  23.         "img_url":     utils.AddDomain2Url(this.Index_image_url),
  24.         "room_count":  this.Room_count,
  25.         "order_count": this.Order_count,
  26.         "address":     this.Address,
  27.         "user_avatar": utils.AddDomain2Url(this.User.Avatar_url),
  28.         "ctime":       this.Ctime.Format("2006-01-02 15:04:05"),
  29.     }
  30.     ],
  32.   }
  33. }

返回失败

  1. {
  2.     "errno": "400x",     //状态码
  3.     "errmsg":"状态错误信息"  //状态信息
  4. }