基于Java的汽车租赁系统的设计与实现的接口详细设计
时间: 2023-09-19 17:05:31 浏览: 99
以下是基于Java的汽车租赁系统的设计与实现的接口详细设计:
1. 用户模块
1.1 用户注册接口
请求方式:POST
请求地址:/user/register
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | ---- | ------ |
| name | 字符串 | 是 | 用户名 |
| password | 字符串 | 是 | 密码 |
| mobile | 字符串 | 是 | 手机号码 |
| email | 字符串 | 是 | 电子邮件地址 |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
1.2 用户登录接口
请求方式:POST
请求地址:/user/login
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| -------- | ---- | ---- | ------ |
| account | 字符串 | 是 | 用户名/手机号码/电子邮件地址 |
| password | 字符串 | 是 | 密码 |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| token | 字符串 | 用户登录凭证 |
1.3 用户信息查询接口
请求方式:GET
请求地址:/user/info
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ----- | ---- | ---- | -------- |
| token | 字符串 | 是 | 用户登录凭证 |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 用户信息 |
2. 车辆模块
2.1 车辆列表查询接口
请求方式:GET
请求地址:/car/list
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | ---- | ------------------- |
| token | 字符串 | 是 | 用户登录凭证 |
| brand | 字符串 | 否 | 车辆品牌,支持模糊查询 |
| model | 字符串 | 否 | 车辆型号,支持模糊查询 |
| status | 整型 | 否 | 车辆状态,0表示未出租,1表示已出租 |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 车辆列表 |
2.2 车辆详情查询接口
请求方式:GET
请求地址:/car/detail
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------- | ---- | ---- | -------- |
| token | 字符串 | 是 | 用户登录凭证 |
| carId | 整型 | 是 | 车辆ID |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 车辆详情 |
2.3 车辆租赁接口
请求方式:POST
请求地址:/car/rent
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------- | ---- | ---- | -------- |
| token | 字符串 | 是 | 用户登录凭证 |
| carId | 整型 | 是 | 车辆ID |
| rentDay | 整型 | 是 | 租赁时长(天) |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
3. 订单模块
3.1 订单列表查询接口
请求方式:GET
请求地址:/order/list
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------ | ---- | ---- | ------------------- |
| token | 字符串 | 是 | 用户登录凭证 |
| status | 整型 | 否 | 订单状态,0表示未完成,1表示已完成 |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 订单列表 |
3.2 订单详情查询接口
请求方式:GET
请求地址:/order/detail
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------- | ---- | ---- | -------- |
| token | 字符串 | 是 | 用户登录凭证 |
| orderId | 整型 | 是 | 订单ID |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 订单详情 |
3.3 订单创建接口
请求方式:POST
请求地址:/order/create
请求参数:
| 参数名 | 类型 | 是否必填 | 描述 |
| ------- | ---- | ---- | -------- |
| token | 字符串 | 是 | 用户登录凭证 |
| carId | 整型 | 是 | 车辆ID |
| rentDay | 整型 | 是 | 租赁时长(天) |
返回值:
| 参数名 | 类型 | 描述 |
| ------- | ---- | ------------ |
| code | 整型 | 返回码,0表示成功,其他表示失败 |
| message | 字符串 | 返回信息 |
| data | 对象 | 订单信息 |
阅读全文