什么是RESETful API架构

最新推荐文章于 2025-04-15 13:35:18 发布

雷小涛的摸爬滚打

最新推荐文章于 2025-04-15 13:35:18 发布

阅读量2.6k

点赞数 2

分类专栏： java相关文章标签： REST RESTful API 接口设计规范四川乐山

本文链接：https://blog.youkuaiyun.com/LeiXiaoTao_Java/article/details/83621357

版权

RESTful API架构由Roy Thomas Fielding提出，代表“表现层状态转化”。每个URI代表一种资源，客户端通过HTTP动词（GET, POST, PUT, DELETE等）操作资源状态。设计原则包括：URL全小写、名词复数形式、易读不暴露架构、使用HTTP状态码和JSON格式返回结果。Spring框架中的实现涉及@RequestMapping注解和ResponseEntity。" 129477003,9235560,C#实现最小二乘法：二次曲线拟合,"['C#编程', '数值计算', '数据分析', '算法']

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、什么是RESTful API架构？

REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写。阮一峰博主将其翻译为"表现层状态转化"。如果一个架构符合REST原则，就称它为RESTful架构。只要理解了Representational State Transfer各个单词的含义，基本上就了解了REST的定义。

1、表现层（Representation）

表现层（Representation）是资源（Resources）的外在表现形式。网络上的一段文本、一张图片、一首歌曲、一种服务都是一种资源。文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。这些资源的格式就是表现层（Representation）。

你可以用一个URI（统一资源标识符）指向它，每种资源对应一个特定的URI。

要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

2、状态转化（State Transfer）

互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

HTTP协议是无状态的，如何用无状态的HTTP协议使服务器发生状态改变呢？这就需要使用HTTP协议里面，常用的4个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

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

（1）每一个URI代表一种资源；

（2）客户端和服务器之间，传递这种资源的某种表现层；

（3）客户端通过HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

二、RESTful API设计原则

1、URL设计

（1）URL 的命名必须全部小写；

（2）URL 中资源（resource）的命名必须是名词，并且应该是复数形式。

（3）URL 必须是易读的

（4）URL 一定不可暴露服务器架构

（5）接口版本号最好放入头部信息中

反例：

https://api.example.com/getUserInfo?userid=1

https://api.example.com/getusers

https://api.example.com/sv/u

https://api.example.com/cgi-bin/users/get_user.php?userid=1

正例：

https://api.example.com/zoos

https://api.example.com/animals

https://api.example.com/zoos/{zoo}/animals

https://api.example.com/animal_types

https://api.example.com/employees

2、HTTP动词

常用的HTTP动词有如下5个（括号内对应服务器操作）