房屋租赁管理系统API

房屋租赁管理系统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用户名Stringzhangsan
password密码String123123

返回参数:

{
    "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房屋类型String3室1厅1卫
houseTitle房屋标题String次卧合作新都环岛 建材城东一里 南次卧 随时看房
houseArea房屋面积String15平
housePrice房屋价格String1200元/月
houseDescribe房屋描述String次卧合作 新都环岛 建材城东一里 南次卧 随时看房
houserOwner房东String1
position房屋位置String建材城东一里
housePic房屋图片filedefault.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房屋类型String3室1厅1卫
houseTitle房屋标题String次卧合作新都环岛 建材城东一里 南次卧 随时看房
houseArea房屋面积String15平
housePrice房屋价格String1200元/月
houseDescribe房屋描述String次卧合作 新都环岛 建材城东一里 南次卧 随时看房
houserOwner房东String1
position房屋位置String建材城东一里
file房屋图片filedefault.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房东idString1
current当前页Integer1
size每页行数Integer10

返回参数:

{
    "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房屋价格或类型String1200
current当前页Integer1
size每页行数Integer10

返回参数:

{
    "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用户idInteger1
signHouse房屋idInteger10

返回参数:

{
    "msg": "成功!",
    "code": 0,
    "data": true
}

2.取消收藏

请求地址: /sign/removeSign/{id}
请求方式:Get
路径参数:收藏id
返回参数:

{
    "msg": "取消收藏成功!",
    "code": 0,
    "data": true
}

3.是否收藏

请求地址: /sign/checkSign
请求方式:Post
请求参数:

名称含义类型例子
signUser用户idInteger1
signHouse房屋idInteger10

返回参数:

{
    "msg": "已经收藏!",
    "code": 0,
    "data": true
}

4.收藏列表

请求地址: /sign/mySign
请求方式:Post
参数类型:application/json
请求参数:

名称含义类型例子
uid用户idInteger1
current当前页Integer1
size每页行数Integer10

返回参数:

{
    "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订单号(随机生成)String18545622454
paymentUser客户idInteger1
paymentHouse房屋idInteger10
payment支付金额BigDecimal1200.00
paymentType支付类型(1-现金,2-支付宝,3-微信,4-其他)Integer10
status订单状态(1-已下单,2-已发货,3-已完成)Integer1

返回参数:

{
    "msg": "添加成功!",
    "code": 0,
    "data": true
}

2.修改订单

请求地址:/payment/editPayment
请求方式:Post
参数类型:application/json
请求参数:

名称含义类型例子
paymentNo订单号(随机生成)String18545622454
paymentUser客户idInteger1
paymentHouse房屋idInteger10
payment支付金额BigDecimal1200.00
paymentType支付类型(1-现金,2-支付宝,3-微信,4-其他)Integer10
status订单状态(1-已下单,2-已发货,3-已完成)Integer1

返回参数:

{
    "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房东/用户idString1
current当前页Integer1
size每页行数Integer10

返回参数:

{
    "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订单状态String1
current当前页Integer1
size每页行数Integer10

返回参数:

{
    "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
    }
}

评论模块

待定

  • 1
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值