房屋租赁管理系统API
第一版:init by admin 2021-03-22
用户模块
1.用户注册:
请求地址: /user/register
请求方式:Post
参数类型:application/json
请求参数:
{
"uName": "Jack", //用户名 not null
"uPassword": "123123", //密码 not null
"uSex": "1", //性别
"uRole": null, //角色 0-管理员 1-普通用户 not null
"uEmail": "123@123.com", //邮箱 not null
"uPhone": null, //手机号
"uWechat": null //微信
}
返回参数:
{
"msg": "注册成功!",
"code": 0,
"data": true
}
2.用户登录:
请求地址:/user/login
请求方式:Post
参数类型:form-data
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
username | 用户名 | String | zhangsan |
password | 密码 | String | 123123 |
返回参数:
{
"msg": "登录成功!",
"code": 0,
"data": {
"uId": 2,
"uName": "Jack",
"uPassword": "123123",
"uSex": "1",
"uRole": null,
"uEmail": "123@123.com",
"uPhone": null,
"uWechat": null,
"makeDate": "2021-03-22T13:02:51.000+00:00",
"modifyDate": "2021-03-22T13:02:51.000+00:00"
}
}
3.修改用户信息:
请求地址: /user/update
请求方式:Post
参数类型:application/json
请求参数:
{
"uId":1 //用户id not null
"uName": "Jack", //用户名
"uPassword": "123123", //密码
"uSex": "1", //性别
"uRole": null, //角色 0-管理员 1-普通用户
"uEmail": "123@123.com", //邮箱
"uPhone": null, //手机号
"uWechat": null //微信
}
返回参数:
{
"msg": "修改成功!",
"code": 0,
"data": true
}
房屋模块:
1.新增房屋信息
请求地址:/house/addHouse
请求方式:Post
参数类型:form-data
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
houseType | 房屋类型 | String | 3室1厅1卫 |
houseTitle | 房屋标题 | String | 次卧合作新都环岛 建材城东一里 南次卧 随时看房 |
houseArea | 房屋面积 | String | 15平 |
housePrice | 房屋价格 | String | 1200元/月 |
houseDescribe | 房屋描述 | String | 次卧合作 新都环岛 建材城东一里 南次卧 随时看房 |
houserOwner | 房东 | String | 1 |
position | 房屋位置 | String | 建材城东一里 |
housePic | 房屋图片 | file | default.jpg |
例如:
{
"houseId": 2,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "01",
"position": "建材城东一里",
"makeDate": "2021-03-22T13:02:51.000+00:00",
"modifyDate": "2021-03-22T13:02:51.000+00:00"
}
返回参数:
{
"msg": "添加成功!",
"code": 0,
"data": true
}
2.修改房屋信息
请求地址:/house/editHouse
请求方式:Post
参数类型:form-data
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
houseType | 房屋类型 | String | 3室1厅1卫 |
houseTitle | 房屋标题 | String | 次卧合作新都环岛 建材城东一里 南次卧 随时看房 |
houseArea | 房屋面积 | String | 15平 |
housePrice | 房屋价格 | String | 1200元/月 |
houseDescribe | 房屋描述 | String | 次卧合作 新都环岛 建材城东一里 南次卧 随时看房 |
houserOwner | 房东 | String | 1 |
position | 房屋位置 | String | 建材城东一里 |
file | 房屋图片 | file | default.jpg |
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
3.房屋出租:
请求地址: /house//leaseHouse/{id}
请求方式:Get
路径id:房屋id
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
4.房屋下架:
请求地址: /house//offHouse/{id}
请求方式:Get
路径id:房屋id
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
5.房屋删除:
请求地址: /house//removeHouse/{id}
请求方式:Get
路径id:房屋id
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
6.房屋信息:
请求地址: /house//getHouse/{id}
请求方式:Get
路径id:房屋id
返回参数:
{
"msg": "成功!",
"code": 0,
"data": {
"houseId": 2,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "01",
"position": "建材城东一里",
"makeDate": "2021-03-22T13:02:51.000+00:00",
"modifyDate": "2021-03-22T13:02:51.000+00:00"
}
}
7.分页查看房屋信息列表
请求地址:/house/myHouse
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
uid | 房东id | String | 1 |
current | 当前页 | Integer | 1 |
size | 每页行数 | Integer | 10 |
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"total": 0,
"size": 10,
"current": 1,
"records": [
{
"houseId": 1,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "02",
"position": "建材城东一里",
"makeDate": "2021-03-22T12:51:20.000+00:00",
"modifyDate": "2021-03-22T12:51:20.000+00:00"
},
{
"houseId": 2,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "01",
"position": "建材城东一里",
"makeDate": "2021-03-22T13:49:03.000+00:00",
"modifyDate": "2021-03-22T13:49:03.000+00:00"
}
],
"pages": 0
}
}
8.分页搜索房屋信息
请求地址:/house/searchHouse
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
key | 房屋价格或类型 | String | 1200 |
current | 当前页 | Integer | 1 |
size | 每页行数 | Integer | 10 |
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"total": 0,
"size": 10,
"current": 1,
"records": [
{
"houseId": 1,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "02",
"position": "建材城东一里",
"makeDate": "2021-03-22T12:51:20.000+00:00",
"modifyDate": "2021-03-22T12:51:20.000+00:00"
},
{
"houseId": 2,
"houseType": "3室1厅1卫",
"houseTitle": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houseArea": "15平",
"housePrice": "1200元/月",
"houseImg": "http://39.103.131.132:80/group1/M00/00/00/J2eDhGBYkdCACfMcAAA8vSjUJzc960.jpg",
"houseDescribe": "次卧合作|新都环岛 建材城东一里 南次卧 随时看房",
"houserOwner": 1,
"state": "01",
"position": "建材城东一里",
"makeDate": "2021-03-22T13:49:03.000+00:00",
"modifyDate": "2021-03-22T13:49:03.000+00:00"
}
],
"pages": 0
}
}
收藏模块
1.添加收藏
请求地址: /sign/addSign
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
signUser | 用户id | Integer | 1 |
signHouse | 房屋id | Integer | 10 |
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
2.取消收藏
请求地址: /sign/removeSign/{id}
请求方式:Get
路径参数:收藏id
返回参数:
{
"msg": "取消收藏成功!",
"code": 0,
"data": true
}
3.是否收藏
请求地址: /sign/checkSign
请求方式:Post
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
signUser | 用户id | Integer | 1 |
signHouse | 房屋id | Integer | 10 |
返回参数:
{
"msg": "已经收藏!",
"code": 0,
"data": true
}
4.收藏列表
请求地址: /sign/mySign
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
uid | 用户id | Integer | 1 |
current | 当前页 | Integer | 1 |
size | 每页行数 | Integer | 10 |
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"total": 0,
"size": 10,
"current": 1,
"records": [
{
"signId":"1",
"signUser":"2",
"signHouse":"3"
}
],
"pages": 0
}
}
订单模块
1.添加订单
请求地址:/payment/addPayment
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
paymentNo | 订单号(随机生成) | String | 18545622454 |
paymentUser | 客户id | Integer | 1 |
paymentHouse | 房屋id | Integer | 10 |
payment | 支付金额 | BigDecimal | 1200.00 |
paymentType | 支付类型(1-现金,2-支付宝,3-微信,4-其他) | Integer | 10 |
status | 订单状态(1-已下单,2-已发货,3-已完成) | Integer | 1 |
返回参数:
{
"msg": "添加成功!",
"code": 0,
"data": true
}
2.修改订单
请求地址:/payment/editPayment
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
paymentNo | 订单号(随机生成) | String | 18545622454 |
paymentUser | 客户id | Integer | 1 |
paymentHouse | 房屋id | Integer | 10 |
payment | 支付金额 | BigDecimal | 1200.00 |
paymentType | 支付类型(1-现金,2-支付宝,3-微信,4-其他) | Integer | 10 |
status | 订单状态(1-已下单,2-已发货,3-已完成) | Integer | 1 |
返回参数:
{
"msg": "保存成功!",
"code": 0,
"data": true
}
3.删除订单
请求地址: /payment/removePayment/{id}
请求方式:Get
路径参数:订单id
返回参数:
{
"msg": "成功!",
"code": 0,
"data": true
}
4.订单信息:
请求地址: /payment//getPayment/{id}
请求方式:Get
路径id:订单id
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"paymentId": 1,
"paymentNo": null,
"paymentUser": 1,
"paymentHouse": null,
"payment": null,
"paymentType": null,
"status": null,
"payDate": null,
"getDate": null,
"makeDate": "2021-03-22T14:54:43.000+00:00",
"modifyDate": "2021-03-22T14:54:43.000+00:00"
}
}
5.分页查看订单信息列表
请求地址:/payment/myPayment
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
uid | 房东/用户id | String | 1 |
current | 当前页 | Integer | 1 |
size | 每页行数 | Integer | 10 |
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"total": 0,
"size": 10,
"current": 1,
"records": [
{
"paymentId": 1,
"paymentNo": null,
"paymentUser": 1,
"paymentHouse": null,
"payment": null,
"paymentType": null,
"status": null,
"payDate": null,
"getDate": null,
"makeDate": "2021-03-22T14:54:43.000+00:00",
"modifyDate": "2021-03-22T14:54:43.000+00:00"
}
],
"pages": 0
}
}
8.分页搜索房屋信息
请求地址:/house/searchHouse
请求方式:Post
参数类型:application/json
请求参数:
名称 | 含义 | 类型 | 例子 |
---|---|---|---|
key | 订单状态 | String | 1 |
current | 当前页 | Integer | 1 |
size | 每页行数 | Integer | 10 |
返回参数:
{
"msg": "success",
"code": 0,
"data": {
"total": 0,
"size": 10,
"current": 1,
"records": [
{
"paymentId": 1,
"paymentNo": null,
"paymentUser": 1,
"paymentHouse": null,
"payment": null,
"paymentType": null,
"status": null,
"payDate": null,
"getDate": null,
"makeDate": "2021-03-22T14:54:43.000+00:00",
"modifyDate": "2021-03-22T14:54:43.000+00:00"
}
],
"pages": 0
}
}
评论模块
待定