RESTful 风格接口书写方式

1 使用 RESTful 风格接口书写方式

1.1 简介

RESTful 的核心思想就是，客户端发出的数据操作指令都是"动词 + 宾语"的结构。请求方式为动词，请求内容为宾语。

1.2 五种请求方式

1. GET 读取
2. POST 新建
3. PUT 更新
4. PATCH 更新（部分更新）
5. DELETE 删除

1.3 需要注意的问题

1. 宾语名词尽量复数
2. 尽量避免多级路径

1.4 对照学习

错误：

GET请求  /getAllCars
GET请求  /getCarById
GET请求 /getCarDetail
POST请求  /createNewCar
PUT请求 /updateCar
DELETE请求  /deleteAllRedCars

正确：

GET请求  /cars
GET请求  /cars/1
GET请求 /cars/detail/1
POST请求  /cars
PUT请求 /cars
DELETE请求  /cars

其实初学者大多会有一些疑问：

1. 如何将获取全部数据和获取筛选后数据的接口写成一个？
2. 如何在请求路径后拼接参数，同时后端可以接收到？
3. GET 请求如何传递对象参数？
4. GET 请求如何传递数组参数
5. 请求参数如何缺省，如何设置默认值？

这些问题在下文会有明确的解决方案。

2 GET 请求参数详解

首先，GET 请求意味着通过 URI 来识别资源，因此 GET 请求的参数应该显式的放于请求路径中。

2.1 参数拼接于路径中

接口：

@GetMapping("/hello/{name}")
public String hello(@PathVariable("name") String name) {
   
    return "获取到的name是：" + name;
}

请求地址：

localhost:8080/hello/tom

请求结果：

获取到的name是：tom

2.2 以键值对形式拼接于路径中

2.2.1 普通单个参数

请求地址中的参数名称跟接口中的形参一致。

接口：

@GetMapping("/hello")
public String hello(