基于 Spring Boot 的 RESTful API 设计与实现

最新推荐文章于 2024-08-08 15:03:46 发布

阿九-进取的测试er

最新推荐文章于 2024-08-08 15:03:46 发布

阅读量483

点赞数 1

文章标签： restful spring boot java

本文链接：https://blog.csdn.net/ceba20200309/article/details/128530086

版权

本文介绍了RESTful API的基本概念，强调了其核心思想，并详细阐述了如何使用Spring Boot来实现RESTful API，包括常用HTTP动词的使用，Controller与RestController的区别，以及具体的接口示例，如用户增删改查操作。同时，文章还提到了Spring Boot的常用配置项，如修改服务端口和多环境配置。

摘要由CSDN通过智能技术生成

RESTful 是一种规范，符合 RESTful 的 Api 就是 RESTful Api。简单的说就是可联网设备利用 HTTP 协议通过 GET、POST、DELETE、PUT、PATCH 来操作具有 URI 标识的服务器资源，返回统一格式的资源信息，包括 JSON、XML、CSV、ProtoBuf、其他格式。
RESTful 的核心思想是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。比如，GET /case 这个命令，GET 是动词，/case 是宾语。

RESTful API简介

RESTful 架构遵循统一接口原则，不论什么样的资源，都是通过使用相同的接口进行资源的访问。接口应该使用标准的 HTTP 方法如 GET ，PUT 和 POST ，并遵循这些方法的语义。

设计规范

常用的动词有以下 5 个

详情见 https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 1

Spring Boot 实现 RESTful API

我们可以通过 Spring Boot 注解来实现 RESTful API 。

现在需要编写的是对一个用户的增删改查操作，如下表是一个非 RESTful 和标准 RESTful 的对比表。

下面我们着重介绍下以下两对注解。

Controller 一般应用在有返回界面的应用场景下。例如，管理后台使用了模板技术如 thymeleaf 开发，需要从后台直接返回 Model 对象到前台，那么这时候就需要使用 Controller 来注解。

RestController 一般应用在只有接口的应用场景下. 例如开发前后端分离的项目时，通过 Ajax 请求服务端接口，那么接口就使用 RestController 统一注解。

需要注意的是 RestController 是 Controller 的子集。RestController 是 Spring4 后新加的注解，从 RestController 注解源码可以看出 RestController 是 Controller 和 ResponseBody 两个注解的结合体，即Controller=RestController+ResponseBody。

RestController 注解源码

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class