Skip to content

Latest commit

 

History

History
338 lines (275 loc) · 8.77 KB

接口文档.md

File metadata and controls

338 lines (275 loc) · 8.77 KB
Raw

vue-next-renting 接口文档

1. API V1 接口说明

  • 基准 URL 地址：https://api.renting.lgdsunday.club/api/
  • 服务端已开启 CORS 跨域支持
  • 数据返回格式统一使用 JSON
  • 数据为网络公开资源

2.接口列表

2.1 获取功能选项列表

  • 请求路径：options
  • 请求方法：get
  • 请求参数：无
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": [{
		"name": "新房",
		"icon": "https://res.lgdsunday.club/renting_xin_fang.png"
		},
        ...
     ]
}

2.2 获取新闻列表

  • 请求路径：news
  • 请求方法：get
  • 请求参数：无
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": [{
		"title": "无论经济如何发展，世界怎样改变， 资产配置始终是高净值人群重点关注的问题。"
		}, ...
    ]
}

2.3 获取房产分类列表

  • 请求路径：tabs
  • 请求方法：get
  • 请求参数：无
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": ["全部", "项目在建", "活动优惠", "VR看房", "专车看房", "大户型", "配套纯属", "医院", "VR看盘", "人气楼盘", "低单价", "新开盘", "特价房源", "一房一价", "独栋别墅", "项目封顶", "大型社区", "热评楼盘", "装修交付", "银行", "车位充足", "全朝南", "低容积", "高绿化率", "南北通透", "轨交房", "花园洋房", "高性价比", "热搜盘"]
}

2.4 获取城市列表

  • 请求路径：cityList
  • 请求方法：get
  • 请求参数：无
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": {
		"recommendList": [{
			"code": "010",
			"name": "北京",
			"pinyin": "Beijing",
			"label": "Beijing010"
		}, {
			"code": "021",
			"name": "上海",
			"pinyin": "Shanghai",
			"label": "Shanghai021"
		}],
		"cityList": [{
			"initial": "A",
			"list": [{
				"code": "0997",
				"name": "阿克苏",
				"pinyin": "Akesu",
				"label": "Akesu0997"
			}]
		}]
	}]
}

2.5 根据房产ID获取房产详情

  • 请求路径：getHouse

  • 请求方法：get

  • 请求参数：

参数名 参数说明 数据类型
houseId 房产 ID String
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": {
		"id": "0",
		"name": "福满街系华瀚品牌馆",
		"maps": ["朝阳", "东坝"],
		"address": "东坝南二街和管庄路交汇处",
		"price": "67730",
		"minArea": "82",
		"maxArea": "186",
		"tags": ["项目在建", "活动优惠", "VR看房", "专车看房"],
		"icon": "https://res.lgdsunday.club/renting_sale_3.jpg",
		"panoramaImg": "https://res.lgdsunday.club/renting_panorama_2.jpg",
		"imags": ["https://res.lgdsunday.club/renting_sale_3.jpg", "https://res.lgdsunday.club/renting_sale_5.jpg", "https://res.lgdsunday.club/renting_sale_7.jpg", "https://res.lgdsunday.club/renting_sale_1.jpg", "https://res.lgdsunday.club/renting_sale_2.jpg"],
		"lng": "116.58161989806",
		"lat": "39.964750858521"
	}
}

2.6 根据房产ID获取推荐房产列表

  • 请求路径：area/recommend

  • 请求方法：get

  • 请求参数：

参数名 参数说明 数据类型
id 房产 ID String
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": {
		"id": "0",
		"name": "福满街系华瀚品牌馆",
		"maps": ["朝阳", "东坝"],
		"address": "东坝南二街和管庄路交汇处",
		"price": "67730",
		"minArea": "82",
		"maxArea": "186",
		"tags": ["项目在建", "活动优惠", "VR看房", "专车看房"],
		"icon": "https://res.lgdsunday.club/renting_sale_3.jpg",
		"panoramaImg": "https://res.lgdsunday.club/renting_panorama_2.jpg",
		"imags": ["https://res.lgdsunday.club/renting_sale_3.jpg", "https://res.lgdsunday.club/renting_sale_5.jpg", "https://res.lgdsunday.club/renting_sale_7.jpg", "https://res.lgdsunday.club/renting_sale_1.jpg", "https://res.lgdsunday.club/renting_sale_2.jpg"],
		"lng": "116.58161989806",
		"lat": "39.964750858521"
	}
}

2.7 获取地图区域房产信息

  • 请求路径：area

  • 请求方法：get

  • 请求参数：

参数名 参数说明 数据类型
parentId（可选） 父区域 ID String
level（可选） 地图级别.可选 0、1、2 String
  • 响应参数
参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": [{
		"id": "642",
		"prop_num": 146273,
		"name": "朝阳",
		"parent_id": "600",
		"mid_price": "71976",
		"mid_change": "-0.00378301",
		"lat": "39.92656",
		"lng": "116.44976"
	}, {
		"id": "818",
		"prop_num": 25118,
		"name": "通州",
		"parent_id": "600",
		"mid_price": "44799",
		"mid_change": "-0.00154788",
		"lat": "39.91624",
		"lng": "116.663214"
	}, {
		"id": "2678",
		"prop_num": 21593,
		"name": "北京周边",
		"parent_id": "600",
		"mid_price": "14316",
		"mid_change": "0.0195556",
		"lat": "39.544097",
		"lng": "116.690164"
	}]
}

2.8 获取地图中任一小区的房产列表

  • 请求路径：area/house

  • 请求方法：get

  • 请求参数：无

  • 响应参数

参数名 参数说明 数据类型
status 响应状态 Number
description 响应描述信息 String
data 响应数据体 Array
  • 响应数据
{
	"status": 200,
	"description": "请求成功",
	"data": [{
		"id": "5",
		"name": "和棠瑞著",
		"maps": ["平谷", "平谷"],
		"address": "金海湖景区坝前广场西侧500米",
		"price": "18000",
		"minArea": "305",
		"maxArea": "350",
		"tags": ["一房一价", "低单价", "项目在建", "独栋别墅"],
		"icon": "https://res.lgdsunday.club/renting_sale_4.jpg",
		"panoramaImg": "https://res.lgdsunday.club/renting_panorama_1.jpg",
		"imags": ["https://res.lgdsunday.club/renting_sale_4.jpg", "https://res.lgdsunday.club/renting_sale_8.jpg", "https://res.lgdsunday.club/renting_sale_7.jpg", "https://res.lgdsunday.club/renting_sale_9.jpg", "https://res.lgdsunday.club/renting_sale_2.jpg", "https://res.lgdsunday.club/renting_sale_6.jpg", "https://res.lgdsunday.club/renting_sale_8.jpg", "https://res.lgdsunday.club/renting_sale_4.jpg"],
		"lng": "117.29248588749",
		"lat": "40.183640647611"
	}, {
		"id": "7",
		"name": "首开龙湖熙悦宸著",
		"maps": ["大兴", "西红门"],
		"address": "京开高速与福欣路交叉口向东100米",
		"price": "64400",
		"minArea": "81",
		"maxArea": "136",
		"tags": ["项目在建", "装修交付", "活动优惠", "大户型"],
		"icon": "https://res.lgdsunday.club/renting_sale_3.jpg",
		"panoramaImg": "https://res.lgdsunday.club/renting_panorama_3.jpg",
		"imags": ["https://res.lgdsunday.club/renting_sale_3.jpg", "https://res.lgdsunday.club/renting_sale_6.jpg", "https://res.lgdsunday.club/renting_sale_1.jpg", "https://res.lgdsunday.club/renting_sale_8.jpg", "https://res.lgdsunday.club/renting_sale_5.jpg"],
		"lng": "116.35037226417",
		"lat": "39.797250039556"
	}]
}