什么是RESTful，REST api设计时应该遵守什么样的规则？

欢迎大家来到IT世界,在知识的湖畔探索吧!

作为一名开发者，相信在看的各位都知道“REST”这个术语，但是 REST 是什么意思，什么是 RESTful 服务？今天笔者带大家好好了解一下 RESTful。

什么是REST？

• 英文全称：Representational State Transfer
• 中文意思：表现层状态转换

REST是客户端应用程序（也就是前端），使用 HTTP 协议与 Web 服务（后端）交互以创建、删除、更新和删除数据（CRUD 操作）的过程。

REST 是由计算机科学家 Roy Fielding 定义的，他在 2000 年的博士论文中介绍了 REST 原则。

符合 REST 的系统，通常称为 RESTful 系统，其特点是它们是无状态的，并且将客户端和服务器的关注点分开，即前后端分离。

前后端分离

在没有前后端分离的时候，开发人员是非常痛苦，这个好比一家公司只有老板一人一样，财务、业务、产品、技术样样都要关心，而且不管前端还是后端，稍微改点东西就会互相影响，测试、维护成本极大。

在 REST 架构风格中，客户端的实现和服务器的实现可以独立完成，彼此不知道对方。这意味着客户端的代码可以随时更改而不影响服务器的运行，而服务器端的代码可以更改而不影响客户端的运行。

欢迎大家来到IT世界,在知识的湖畔探索吧!

只要双方都知道要发送给对方的消息格式，它们就可以保持模块化和分离，将用户界面关注点与数据存储关注点分开，这样可以极大提高跨平台界面的灵活性，并通过简化服务器组件来提高可扩展性。

这就是前后端分离的优势所在。

如何使用REST API？

HTTP 动词

REST API 通过各种 HTTP 请求方法，使前端与服务器的通信过程更容易，最常用的方法是：

• GET : 用于读取服务器上的数据。
• POST : 用于创建数据。
• PATCH/PUT：用于更新数据。
• DELETE : 用于删除数据。

路径

请求必须包含指向应该对其执行操作的资源的路径。

在RESTful风格中，应该遵守以下原则：

1. URL 应该包含名词，而不是动词

比如获取用户列表，正确的是：

https://www.wljslmz.cn/users 

欢迎大家来到IT世界,在知识的湖畔探索吧!

错误的是：

欢迎大家来到IT世界,在知识的湖畔探索吧!https://www.wljslmz.cn/getUsers 

2、URL使用复数，而不是单数

还是上面的例子，获取用户列表，正确的是：

https://www.wljslmz.cn/users 

错误的是：

欢迎大家来到IT世界,在知识的湖畔探索吧!https://www.wljslmz.cn/user 

3、URL中最好包含版本号，假如没有，那么应该认为是最新版，而不是稳定版

比如：

https://www.wljslmz.cn/v1/users 

4、URL中使用嵌套来显示关系

比如获取id为1的用户信息：

欢迎大家来到IT世界,在知识的湖畔探索吧!https://www.wljslmz.cn/v1/users/1 

5、URL分页

分页可以轻松处理大量请求结果，例如，Web 服务包含数百或数千个页面，当请求显示其所有页面时，将获得相同数量的结果作为回应。

比如分页显示用户信息列表：

https://www.wljslmz.cn/v1/users/page=1?limit=10 

6、使用连字符增加可读性

最好用连字符-，而不是_或者驼峰，在所有 RESTful API 中，连字符等同于空格。

比如用户id为1的用户开始工作：

欢迎大家来到IT世界,在知识的湖畔探索吧!https://www.wljslmz.cn/v1/users/1/start-work 

7、URL最好不用大写

使用大写字母定义资源会使 URL 键敏感，在特定情况下可能会导致混淆，使用小写字母将确保命令的正确性，即使 URL 是用大写字母输入的，但反之则不然：

比如上面第6个url最好不要写成：

https://www.wljslmz.cn/v1/users/1/Start-Sork 

你写成这样：

欢迎大家来到IT世界,在知识的湖畔探索吧!https://www.wljslmz.cn/v1/users/1/start-work 

即使你在浏览器中输入：
https://www.wljslmz.cn/v1/users/1/Start-Sork，也会正确匹配到
https://www.wljslmz.cn/v1/users/1/start-work。

但是假如api是
https://www.wljslmz.cn/v1/users/1/start-work，那么你在浏览器中必须是大写形式。

常见的 HTTP 状态码

• 1xxs：信息响应，服务器仍在处理请求。
• 2xxs：成功，请求成功完成
• 3xxs：重定向，收到的请求重定向到另一个地址。
• 4xxs：客户端错误，例如，404 – 找不到页面。
• 5xxs：服务器错误，请求失败。

一些常见的 HTTP 状态代码包括：

• 200：成功的请求，通常是 GET
• 201：创建后请求成功，通常是 POST
• 204：请求成功，没有返回内容，通常是 PUT 或 PATCH
• 301：永久重定向到另一个端点
• 400：错误请求（客户端应修改请求）
• 401：未经授权，凭据无法识别
• 403：禁止，凭据接受但没有权限
• 404：未找到，资源不存在
• 410：消失了，资源以前存在但现在不存在
• 429：请求过多，用于速率限制，应包含重试标头
• 500：服务器错误，一般性，值得查看其他 500 级错误
• 503：服务不可用，另一个重试标头有用

总结

REST是一种软件架构风格，用于 Web 架构的设计，任何遵循 REST 设计原则的 API都被称为 RESTful，在开发初期，开发者需要花费大量的时间去设计接口，这些接口一般都是遵循RESTful风格，力争接口简单、易懂。