Restful教程

最新推荐文章于 2024-06-03 13:13:48 发布

忆白@

最新推荐文章于 2024-06-03 13:13:48 发布

阅读量82

点赞数

文章标签： restful 后端

本文链接：https://blog.csdn.net/weixin_70176200/article/details/134572235

版权

REST教程

越来越多的人开始意识到，网站即软件，而且是一种新型的软件。这种"互联网软件"采用客户端/服务器模式，建立在分布式体系上，通过互联网通信，具有高延时（high latency）、高并发等特点。

网站开发，完全可以采用软件开发的模式。但是传统上，软件和网络是两个不同的领域，很少有交集；软件开发主要针对单机环境，网络则主要研究系统之间的通信。互联网的兴起，使得这两个领域开始融合，现在我们必须考虑，如何开发在互联网环境中使用的软件。而RESTful架构，就是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。

1. REST风格与RESTful架构

REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。这个词组的翻译是"表现层状态转化"。如果一个架构符合REST原则，就称它RESTful架构。要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。

1.1 资源（Resources）

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

1.2 表现层（Representation）

“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层”（Representation）。比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

1.3 状态转化（State Transfer）

访问某一个网站，就代表了客户端和服务器的一个交互过程。在这个过程中，势必涉及到数据和状态的变化。互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。而客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，常见的四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

综合上面的描述，我们总结一下什么是RESTful架构：

每一个URI描述一种资源；
客户端和服务器之间，传递这种资源的某种表现层；
客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

2. RESTful API设计规范

网络应用程序，分为前端和后端两个部分。当前的发展趋势，前端设备种类繁多（手机、平板、桌面电脑、其他专用设备等等），并且很多时候前端和后端是分离开来开发和部署。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

2.1 域名

RESTful API通常使用https协议并提供相应的域名给客户端进行访问。并且尽量将API部署在专用的二级域名下，例如：

https://api.example.com

如果API相对简单，可以直接部署在一级域名下，例如：

https://example.com/api/

2.2 版本

版本号是为了保证API 的稳定性，并且向下兼容。在 API 没有变化的时候，API 实现的更新和升级，都应该确保原有客户端请求不出现问题。这种方式通常在 URI 中增加一段用于标识版本，例如/v1、/v2等。例如：

https://api.example.com/v1/

或者

https://example.com/api/v/

2.3 路径

路径又称"终点"（endpoint），表示API的具体网址。在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种对象记录的"集合"（collection），所以API中的名词也应该使用复数。举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

或者

https://example.com/api/v1/zoos/1
https://example.com/api/v1/animals
https://example.com/api/v1/employees

2.4 HTTP动词

对于资源的具体操作类型，由HTTP动词表示。常用的HTTP动词有下面七个（括号里是对应的相关操作）。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。（不常用）
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。（不常用）

例如：

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/id：获取某个指定动物园的信息
PUT /zoos/id：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/id：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/id：删除某个动物园信息
GET /zoos/id/animals：列出某个指定动物园的所有动物
DELETE /zoos/id/animals/id：删除某个指定动物园的某个动物信息

2.5 过滤信息

如果检索的记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。例如下面是一些常见的请求过滤参数。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page_num=1&page_size=20：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

2.6 状态码

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有认证（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户没有访问权限，被禁止访问。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

2.7 错误处理

如果状态码是4xx或者5xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{
    error: "Invalid API key"
}

3. Springdoc-openApi构建RESTful API

使用RESTful API作为Web服务对外提供服务的入口，基本上已经成为了标准，在提供REST API的同时，如何进行 API文档管理是一个较为麻烦的事情，作为开发人员我们都了解API文档的重要性，但总是嫌其编写的麻烦，openapi的出现很好地帮我们解决文档编写的事情，开发人员可以采取自己喜欢的方式进行API文档编写，并且通过springdoc可以很好的和Spring框架集成。

3.1 添加Maven依赖

        <!-- 推荐使用springdoc-openapi来生成rest的api文档 -->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.6.15</version>
        </dependency>

3.2 集成OpenAPI

首先创建一个配置类，如下：

/**
* api页面访问地址:
* http://localhost:8080/上下文/swagger-ui/index.html
*/
@Configuration
//使用注解配置OpenApi
@OpenAPIDefinition(info = @Info(
        title = "项目接口文档",
        version = "v1.0",
        description = "基于springboot开发的API接口",
        license = @License(name = "MIT", url = "http://springdoc.org")
        ),
        externalDocs = @ExternalDocumentation(description = "参看文档", url = "https://gitee.com")
)
public class OpenApiConfig {
}

3.3 配置静态资源

接下来还需要配置Spring MVC的Resource Handler，它有些静态资源需要加载。

Java配置：

Sping mvc配置类实现WebMvcConfigurer接口，并重写addResourceHandlers方法。

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("swagger-ui.html")
      .addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**")
      .addResourceLocations("classpath:/META-INF/resources/webjars/");
}

或者使用Xml配置：

<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

最后运行项目，在浏览器中输入：

http://localhost:8080/swagger-ui.html

可以看到如下web页面：

3.4案例

@RestController
@RequestMapping("/api/v1")
@Tag(name = "UserApiController", description = "用户API接口")
public class UserApiController extends BaseController {

    @GetMapping("/users")
    @Operation(method = "GET", summary = "用户查询",
            description = "查询所有用户信息")
    @ApiResponses({
            @ApiResponse(responseCode = "200", description = "查询完成"),
            @ApiResponse(responseCode = "500", description = "内部查询错误")
    })
    public ResultVO<List<User>> listUser() {
        User u1 = new User("1001", "user1", 21);
        User u2 = new User("1002", "user2", 20);
        List<User> list = Arrays.asList(u1, u2);
        return success(list);
    }

    @GetMapping("/user/{id}")
    @Operation(method = "GET", summary = "用户查询",
            description = "根据用户ID查询详细信息")
    @Parameters({
            @Parameter(name = "id", description = "用户ID",
                    required = true, in = ParameterIn.PATH)
    })
    @ApiResponses({
            @ApiResponse(responseCode = "200", description = "查询完成"),
            @ApiResponse(responseCode = "500", description = "内部查询错误")
    })
    public ResultVO<User> getUser(@PathVariable("id") String uid) {
        User user = new User(uid, "user1", 19);
        return success(user);
    }
}