跳到主要内容

Spring Boot 3.x- 构建RESTful API

系列文章目录​

系列文章:Spring Boot 3.x 系列教程

文章目录​

  • 系列文章目录
  • 一、什么是REST
  • 二、RESTful API设计原则
  • 三、Spring Boot 3构建 RESTful API
    • 1.新建项目导入依赖库
  • 2.表结构设计
  • 3.接口设计
  • 4.对象转换&Repository &Service
    • 1.对象转化
    • 2.Repository接口实现
    • 3.Service实现
  • 5.controller
    • 测试&异常统一处理
  • 总结

一、什么是REST​

REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，Roy Fielding是 HTTP 规范的主要编写者之一。在目前主流的三种Web服务交互方案中，REST相比于SOAP（Simple Object Access protocol，简单对象访问协议）以及XML-RPC更加简单明了，无论是对URL的处理还是对Payload的编码，REST都倾向于用更加简单轻量的方法设计和实现。值得注意的是REST并没有一个明确的标准，而更像是一种设计的风格。

REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。

二、RESTful API设计原则​

1、 通信协议；

> API通信协议使用HTTPS协议

1、 部署域名；

> API部署到专有域名下: https://api.example.com 或者 https://example.com/api/

1、 API版本；

> API版本号放入URL https://api.example.com/v1

1、 面向资源；

> 在RESTful架构中，每个URI代表一种资源（resource），所以URI中不能有动词，只能有名词，而且所用的名词往往与数据库的表名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。