RESTful 架构

系统管理员 2023-10-07 11:37 26阅读 0赞

### 起源 ###

REST（Representational State Transfer，表现层状态转换）是 Roy Thomas Fielding 博士于 2000 年在他的博士论文 [Architectural Styles and the Design of Network-based Software Architectures][] 中提出。

### 理解 ###

#### 直译版本 ####

> Representation：表现  
> State：状态  
> Transfer：转换

将上述三者连起来：表现层的状态转换，是不是有点拗口，毕竟 `缺少个主语`。那么，继续读下文就可以了。

#### 意译版本 ####

> Resources：资源  
> Representation：表现  
> State：状态  
> Transfer：转换

将缺少的主语 `Resources（资源）`补充上连起来再读，资源[表现层][Link 1]的状态转换。是不是比之前读起来舒服多了。再将各个单词解释下：

1.  Resources：资源。网络上传输的各项数据，比如文本，图片。
2.  Representation：表现。资源有多种表现形式，比如文本可以有 txt 格式、XML 格式；图片有 jpg 格式。
3.  State Transfer：状态转换。对保存在服务器端的资源及其状态利用 [HTTP 方法][HTTP] 进行修改，比如 GET、POST、DELETE、PUT。

强调下：是资源在网络传输中进行的表现形式的转换。

### 好处 ###

1.  通过看 RESTful API 你可以看到 URI+[HTTP Method][HTTP]，即「要什么+做什么」；
2.  通过看 [HTTP Status Code][] 你就可以知道结果如何。

### 技巧 ###

1.  使用 `_` 或 `-` 来让 URI 可读性更好，推荐使用 `-`；
2.  使用 `/` 来表示资源的层级关系；
3.  使用 `?` 来过滤资源；
4.  `,` 或 `;` 可以用来表示同级资源的关系。

### 误区 ###

1.  URI 包含动词；
2.  URI 中有版本号。

### 推荐阅读 ###

[“一把梭：REST API 全用 POST”][REST API _ POST] （强烈推荐）

[RESTful 架构详解][RESTful]

[理解RESTful架构][RESTful 1]

[面向资源编程-RESTful风格][-RESTful]

[RESTful API Design. Best Practices in a Nutshell.][]

[\[译\] RESTful API 设计最佳实践][RESTful API]

[WEB开发中，使用JSON-RPC好，还是RESTful API好][WEB_JSON-RPC_RESTful API]

[Architectural Styles and the Design of Network-based Software Architectures]: https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
[Link 1]: https://mindartisan.blog.csdn.net/article/details/104242663
[HTTP]: https://mindartisan.blog.csdn.net/article/details/105015654
[HTTP Status Code]: https://mindartisan.blog.csdn.net/article/details/93312245
[REST API _ POST]: https://coolshell.cn/articles/22173.html
[RESTful]: https://www.runoob.com/w3cnote/restful-architecture.html
[RESTful 1]: https://www.ruanyifeng.com/blog/2011/09/restful.html
[-RESTful]: https://www.imooc.com/read/75/article/1806
[RESTful API Design. Best Practices in a Nutshell.]: https://phauer.com/2015/restful-api-design-best-practices/
[RESTful API]: https://juejin.cn/post/6844903503953920007
[WEB_JSON-RPC_RESTful API]: https://www.zhihu.com/question/28570307/answer/541465581