当前位置: 首页 > news >正文

【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"

相关文章:

  • 第3章 Internet主机与网络枚举(网络安全评估)
  • Python 爬取 1688 详情接口数据返回说明
  • Mysql架构理论部分
  • github代理 | 快速clone项目
  • 简单理解机器学习中top_k、top_p、temperature三个参数的作用
  • 前端开发:Vue以及Vue的路由
  • AsyncHttpClient使用说明书
  • Android Compose 切换按钮深度剖析:从源码到实践(六)
  • SpringBoot @Scheduled注解详解
  • SQL宏-代替UDF
  • JSONPath 的介绍
  • 搭建主从DNS、nfs、nginx
  • 【MySQL】undo日志页结构
  • 智能遥感新质生产力暨DeepSeek、Python、OpenCV驱动的空天地数据识别与计算及15个行业标杆案例
  • linux 之 查看进程运行时长
  • C# SerialPort 使用详解
  • Linux中修改文件的权限用什么命令?
  • 前端项目完结--上线打包发布步骤和方法
  • MySQL 中,查看执行频次、慢查询日志、SHOW PROFILE和 EXPLAIN性能分析和优化
  • 可视化图解算法:删除链表中倒数第n个节点
  • 横跨万里穿越百年,《受到召唤·敦煌》中张艺兴一人分饰两角
  • 挖掘机4月销量同比增17.6%,出口增幅创近两年新高
  • 举牌代跳明码标价、留言不堪入目,未成年人擦边短视频成引流利器
  • A股低开高走全线上涨:军工股再度领涨,两市成交12934亿元
  • 深入贯彻中央八项规定精神学习教育中央第六指导组指导督导中国工商银行见面会召开
  • 中国以“大幅开放市场”回应贸易保护主义