Restful风格

目录

1.概念

2.请求路径（URL）

3.请求方式（HTTP方法）

4.请求参数

5.返回值

6.相关注解

7.举例

---

1.概念

Representational State Transfer，简称REST，表现层状态转移

restful的风格其实是一种规范，用来规范我们在写接口时的命名，用于前端与后端、项目与项目之间来传递数据。

2.请求路径（URL）

用于标识资源的路径。URL应该清晰地指示出要操作的资源，例如 /users 表示操作用户资源，/users/123 表示操作用户编号为123的具体用户。

3.请求方式（HTTP方法）

get	从服务器获取资源
post	在服务器创建资源
put	在服务器更新完整资源
patch	在服务器更新个别资源
delete	在服务器删除

4.请求参数

根据操作的具体需求

5.返回值

HTTP响应包含了对请求的处理结果，通常包括状态码、响应头和响应体

6.相关注解

7.举例

如下一个接口信息

@RestController
@RequiredArgsConstructor
@RequestMapping("/likes")  //指定了以 /likes 开头的请求路径
@Api(tags = "xx业务接口")
public class LikedRecordController {

    private final ILikedRecordService likedRecordService;

    @PostMapping    //表示该方法将处理POST请求
    @ApiOperation("xxxx")
//@Valid @RequestBody LikeRecordFormDTO recordDTO：这个参数表示从HTTP请求体中获取JSON数据，并将其转换成 LikeRecordFormDTO 对象
    public void addLikeRecord(@Valid @RequestBody LikeRecordFormDTO recordDTO) {
        likedRecordService.addLikeRecord(recordDTO);
    }
}