当前位置: 首页 > 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"
http://www.dtcms.com/a/83017.html

相关文章:

  • 第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个节点
  • 在 Linux 系统中,路径(Path)用于定位文件或目录的位置。路径分为两种类型:相对路径和绝对路径。它们的核心区别在于路径的起点不同
  • 枚举的定义及其使用
  • 《齿轮咬合水分子:Relax Max如何用潜艇科技重构卫浴动力系统》​
  • 科技赋能安全:慧通测控的安全带全静态性能测试
  • STM32学习笔记之常用总线(原理篇)
  • 分布式节点池:群联云防护抗DDoS的核心武器
  • 大摩闭门会:250321 学习总结报告
  • 从实践到创新:低代码驱动教育行业数字化转型
  • 田间机器人幼苗视觉检测与护苗施肥装置研究(大纲)
  • 【Vitis AIE】FPGA图像处理 11 双线性插值 Bilinear Interpolation