IT评测·应用市场-qidao123.com

标题: 【SpringBoot】MorningBox小步调的完整后端接口文档 [打印本页]

---

作者: 道家人    时间: 2025-3-22 04:43
标题: 【SpringBoot】MorningBox小步调的完整后端接口文档
以下是「晨光宅配」小步调的完整接口文档，涵盖了所有12个表的接口。
每个接口包括哀求方法、URL、哀求参数、相应格式和示例
接口文档

1. 用户模块

1.1 获取用户信息

• URL: /user/{userId}
  
• 方法: GET
  
• 哀求参数:
  
     
  
  • userId (路径参数): 用户ID  
    
    
  
• 相应格式:
  1. {
  2.      
  3.   "userId": 1,
  4.   "openid": "openid_123456",
  5.   "phone": "13800138000",
  6.   "nickname": "小明",
  7.   "avatarUrl": "https://example.com/avatar1.jpg",
  8.   "createTime": "2023-10-01T12:00:00"
  9. }

  复制代码

1.2 获取所有效户

• URL: /user
  
• 方法: GET
  
• 相应格式:
  1. [
  2.   {
  3.      
  4.     "userId": 1,
  5.     "openid": "openid_123456",
  6.     "phone": "13800138000",
  7.     "nickname": "小明",
  8.     "avatarUrl": "https://example.com/avatar1.jpg",
  9.     "createTime": "2023-10-01T12:00:00"
  10.   }
  11. ]

  复制代码

1.3 创建用户

• URL: /user
  
• 方法: POST
  
• 哀求体:
  1. {
  2.      
  3.   "openid": "openid_123456",
  4.   "phone": "13800138000",
  5.   "nickname": "小明",
  6.   "avatarUrl": "https://example.com/avatar1.jpg"
  7. }

  复制代码
  
  
• 相应格式:
  1. true

  复制代码

1.4 更新用户

• URL: /user
  
• 方法: PUT
  
• 哀求体:
  1. {
  2.      
  3.   "userId": 1,
  4.   "openid": "openid_123456",
  5.   "phone": "13800138000",
  6.   "nickname": "小明",
  7.   "avatarUrl": "https://example.com/avatar1.jpg"
  8. }

  复制代码
  
  
• 相应格式:
  1. true

  复制代码

1.5 删除用户

• URL: /user/{userId}
  
• 方法: DELETE
  
• 哀求参数:
  
     
  
  • userId (路径参数): 用户ID  
    
    
  
• 相应格式:
  1. true

  复制代码

1.6 搜索用户

• URL: /user/search?keyword=小明
  
• 方法: GET
  
• 哀求参数:
  
     
  
  • keyword (查询参数): 搜索关键字  
    
    
  
• 相应格式:
  1. [
  2.   {
  3.      
  4.     "userId": 1,
  5.     "openid": "openid_123456",
  6.     "phone": "13800138000",
  7.     "nickname": "小明",
  8.     "avatarUrl": "https://example.com/avatar1.jpg",
  9.     "createTime": "2023-10-01T12:00:00"
  10.   }
  11. ]

  复制代码

<hr> 2. 地址模块

2.1 获取用户地址列表

• URL: /address/user/{userId}
  
• 方法: GET
  
• 哀求参数:
  
     
  
  • userId (路径参数): 用户ID  
    
    
  
• 相应格式:
  1. [
  2.   {
  3.      
  4.     "addressId": 1,
  5.     "userId": 1,
  6.     "contactName": "小明",
  7.     "contactPhone": "13800138000",
  8.     "detailAddress": "北京市朝阳区XX路XX号",
  9.     "isDefault": 1
  10.   }
  11. ]

  复制代码

2.2 添加地址

• URL: /address
  
• 方法: POST
  
• 哀求体:
  1. {
  2.      
  3.   "userId": 1,
  4.   "contactName": "小明",
  5.   "contactPhone": "13800138000",
  6.   "detailAddress": "北京市朝阳区XX路XX号",
  7.   "isDefault": 1
  8. }

  复制代码
  
  
• 相应格式:
  1. true

  复制代码

2.3 更新地址

• URL: /address
  
• 方法: PUT
  
• 哀求体:
  1. {
  2.      
  3.   "addressId": 1,
  4.   "userId": 1,
  5.   "contactName": "小明",
  6.   "contactPhone": "13800138000",
  7.   "detailAddress": "北京市朝阳区XX路XX号",
  8.   "isDefault"

  复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 IT评测·应用市场-qidao123.com (https://dis.qidao123.com/)

Powered by Discuz! X3.4