周振林 周振林
首页
  • 前端文章

    • HTML
    • CSS
    • Tailwind CSS (opens new window)
    • JavaScript
    • Vue3
    • 其他
  • Spring
  • SpringMVC
  • Mybatis
  • 安装教程
  • 其他教程
  • 基础
  • 虚拟化
  • Docker
  • OpenStack
  • 心情杂货
关于
收藏

周振林

IT界的小学生
首页
  • 前端文章

    • HTML
    • CSS
    • Tailwind CSS (opens new window)
    • JavaScript
    • Vue3
    • 其他
  • Spring
  • SpringMVC
  • Mybatis
  • 安装教程
  • 其他教程
  • 基础
  • 虚拟化
  • Docker
  • OpenStack
  • 心情杂货
关于
收藏
  • Spring

    • 接口设计规范
      • 接口设计规范
    • Spring IoC
    • Spring AOP
    • SpringBoot基础
    • SpringBoot 常用注解
    • SpringBoot Conditional注解
    • SpringBoot 组件注入方式
    • SpringBoot 组件Bean生命周期
    • SpringBoot自动配置原理
    • SpringBoot自定义Starter
    • SpringBoot其他功能
    • SpringBoot JdbcTemplate
    • SpringBoot事务
    • SpringBoot文档
    • SpringBoot Starter和BOM区别
    • SpringBoot集成Modbus实现设备
    • 查询优化N+1
    • Response设置响应编码
    • Thymeleaf教程
    • Maven教程
    • Tree工具类,轻松搞定树结构
    • 项目代码组织方式
  • SpringMVC

  • Mybatis

  • 安装教程

  • 其他教程

  • 后端
  • Spring
周振林
2022-11-27
目录

接口设计规范

# 接口设计规范

业务场景 请求方式 传参方式 控制器方法名 接口路径示例
查询字典 GET 无 dict /api/order/dict
订单分页查询 POST JSON page /api/order/page
订单查询不分页 POST JSON list /api/order/list
订单详情 GET PATH detail /api/order/detail/{id}
订单创建 POST JSON create /api/order/create
订单取消 DELETE JSON cancel /api/order/cancel
订单批量取消 POST JSON batchCancel /api/order/batchCancel
订单修改 PUT JSON update /api/order/update
订单添加商品 POST JSON itemAdd /orders/{orderId}/items
订单导出 POST JSON export /api/order/export
订单支付 POST JSON pay /api/order/pay
订单退款 POST JSON refund /api/order/refund
订单发货 POST JSON deliver /api/order/deliver
客户订单查询 POST JSON countByMonth /api/customer-order/countByMonth
客户添加标签 POST JSON addTag /api/customer-tag/add
客户账户充值 POST JSON recharge /api/customer-account/recharge
  1. 业务动作类接口 针对 “非 CRUD 但有明确业务行为” 的操作(如订单支付、商品上架),用资源+动词命名
  • /api/order/pay
  • /api/order/refund
  1. 资源关联类接口 针对 “多资源关联操作”(如给用户分配角order-item/add
  • 关联解除(如用户取消关联标签):DE色、订单添加商品),用资源1 + 连字符 + 资源2 + 动作命名
  • 关联创建(如订单添加商品):POST /LETE /user-tag/remove
  • 客户添加标签: POST /api/customer-tag/add
Last Updated: 2025/12/02, 11:22:00
Spring IoC

Spring IoC→

最近更新
01
查询优化N+1
12-02
02
项目代码组织方式
12-02
03
Mybatis分页插件
12-02
更多文章>
Copyright © 2019-2025 鲁ICP备19032096号-1
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×