【SpringBoot】MorningBox小程序的完整后端接口文档
以下是「晨光宅配」小程序的完整接口文档,涵盖了所有12个表的接口。
每个接口包括请求方法、URL、请求参数、响应格式和示例
接口文档
1. 用户模块
1.1 获取用户信息
- URL:
/user/{userId}
- 方法:
GET
- 请求参数:
userId
(路径参数): 用户ID
- 响应格式:
{ "userId": 1, "openid": "openid_123456", "phone": "13800138000", "nickname": "小明", "avatarUrl": "https://example.com/avatar1.jpg", "createTime": "2023-10-01T12:00:00" }
1.2 获取所有用户
- URL:
/user
- 方法:
GET
- 响应格式:
[ { "userId": 1, "openid": "openid_123456", "phone": "13800138000", "nickname": "小明", "avatarUrl": "https://example.com/avatar1.jpg", "createTime": "2023-10-01T12:00:00" } ]
1.3 创建用户
- URL:
/user
- 方法:
POST
- 请求体:
{ "openid": "openid_123456", "phone": "13800138000", "nickname": "小明", "avatarUrl": "https://example.com/avatar1.jpg" }
- 响应格式:
true
1.4 更新用户
- URL:
/user
- 方法:
PUT
- 请求体:
{ "userId": 1, "openid": "openid_123456", "phone": "13800138000", "nickname": "小明", "avatarUrl": "https://example.com/avatar1.jpg" }
- 响应格式:
true
1.5 删除用户
- URL:
/user/{userId}
- 方法:
DELETE
- 请求参数:
userId
(路径参数): 用户ID
- 响应格式:
true
1.6 搜索用户
- URL:
/user/search?keyword=小明
- 方法:
GET
- 请求参数:
keyword
(查询参数): 搜索关键字
- 响应格式:
[ { "userId": 1, "openid": "openid_123456", "phone": "13800138000", "nickname": "小明", "avatarUrl": "https://example.com/avatar1.jpg", "createTime": "2023-10-01T12:00:00" } ]
2. 地址模块
2.1 获取用户地址列表
- URL:
/address/user/{userId}
- 方法:
GET
- 请求参数:
userId
(路径参数): 用户ID
- 响应格式:
[ { "addressId": 1, "userId": 1, "contactName": "小明", "contactPhone": "13800138000", "detailAddress": "北京市朝阳区XX路XX号", "isDefault": 1 } ]
2.2 添加地址
- URL:
/address
- 方法:
POST
- 请求体:
{ "userId": 1, "contactName": "小明", "contactPhone": "13800138000", "detailAddress": "北京市朝阳区XX路XX号", "isDefault": 1 }
- 响应格式:
true
2.3 更新地址
- URL:
/address
- 方法:
PUT
- 请求体:
{ "addressId": 1, "userId": 1, "contactName": "小明", "contactPhone": "13800138000", "detailAddress": "北京市朝阳区XX路XX号", "isDefault"