讲师中心 微信公众号
AI工具推荐 视频效率加速

SpringBoot 5.3 Starter RESTful API设计与规范【接口开发】

夏杰大大_5300

夏杰大大_5300

发布时间:2026-08-08 20:27:40

|

843人浏览过

|

来源于php中文网

原创

Spring Boot 5.3 RESTful API 必须遵循规范:使用 @RestController、统一 /api/v1 前缀、资源路径无动词、嵌套≤两层、GET/POST 按参数复杂度选择、统一 ApiResponse 封装、@Valid 校验+全局异常处理。

springboot 5.3 starter restful api设计与规范【接口开发】

要在 Spring Boot 5.3 中快速搭建符合行业标准的 RESTful API,必须从控制器定义、URL 结构、HTTP 方法映射到响应格式全程遵循规范,避免因动词混入路径或状态码误用导致前端联调反复失败。

定义资源型控制器

使用 @RestController 替代 @Controller + @ResponseBody 组合,这是 Spring Boot 5.3 的默认推荐方式,省去手动标注响应体序列化的冗余操作。

在类级别添加 @RequestMapping("/api/v1"),为所有接口统一前缀,版本号必须显式声明,【不建议将版本放在请求头中】,否则 Swagger 文档无法自动识别且 Nginx 路由配置复杂化。

控制器类名以 Controller 结尾,例如 UserController,不要写成 UserAPI 或 UserHandler。

URL 路径与 HTTP 方法精准匹配

按操作类型严格选用注解:查询集合用 @GetMapping("/users"),查单个用 @GetMapping("/users/{id}"),新增用 @PostMapping("/users"),全量更新用 @PutMapping("/users/{id}"),部分更新用 @PatchMapping("/users/{id}"),删除用 @DeleteMapping("/users/{id}")。

路径中禁止出现动词:/getUserById → 必须改为 /users/{id};/searchOrdersByStatus → 必须改为 /orders?status=xxx。

嵌套资源最多两层:/departments/{deptId}/employees 是可接受的,但 /departments/{deptId}/teams/{teamId}/members 不符合 Spring Boot 5.3 官方推荐实践,应拆分为独立端点或改用查询参数。

查询接口的 GET 与 POST 决策

方法一:简单条件走 GET

当参数全部为字符串、数字、日期(≤8 个),且无嵌套结构时,强制使用 GET。例如:@GetMapping("/products") 接收 @RequestParam String name, @RequestParam LocalDate startDate。

方法二:复杂条件必须用 POST

只要 DTO 中含 List、Map、嵌套对象(如 PriceRange)、或字段数 ≥9,就必须改用 @PostMapping("/products/search") 并接收 @RequestBody ProductSearchDTO。GET 的 URL 长度限制在 Spring Boot 5.3 默认嵌入 Tomcat 下为 2048 字符,超长会直接返回 400 错误且无日志提示。

统一响应结构实现

第一步:创建泛型响应类 ApiResponse<T>,包含 code、message、data、timestamp 四个字段,构造器私有,仅暴露 success() 和 fail() 静态工厂方法。

第二步:在 Controller 方法返回值统一包装为 ApiResponse<User>,而非裸返回 User 或 Page<User>。Spring Boot 5.3 的 ResponseEntity 已不推荐用于业务响应封装,它更适合控制 HTTP 状态码和 Header 的底层场景。

第三步:用 @ControllerAdvice + @ResponseBodyAdvice 拦截所有返回值,自动套用 ApiResponse 包装,避免每个方法手写 ApiResponse.success(user)。

参数校验与错误响应

在 DTO 字段上标注 @NotBlank、@NotNull、@Min(1) 等 javax.validation 注解,Controller 方法参数前加 @Valid。

全局异常处理器捕获 MethodArgumentNotValidException,提取 BindingResult 中第一个错误字段,组装成 ApiResponse.fail(400, "用户名不能为空") 并返回 400 状态码。

注意:@Validated 与 @Valid 在 Spring Boot 5.3 中行为一致,但 【分组校验必须用 @Validated】,否则分组失效。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2191

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

417

2026.01.26

PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

504

2025.11.26

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3048

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

4329

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3689

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

386

2026.01.19

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

120

2026.09.23

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

40

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Redis6入门到精通超详细教程
Redis6入门到精通超详细教程

共47课时 | 7.1万人学习

ThinkPHP6.x API接口--十天技能课堂
ThinkPHP6.x API接口--十天技能课堂

共14课时 | 1.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn