RESTful API

最新推荐文章于 2023-05-15 07:52:14 发布

Lawliet-zhang

最新推荐文章于 2023-05-15 07:52:14 发布

阅读量201

点赞数 1

分类专栏：架构文章标签： rest restful 架构 HTTP动词 api

本文链接：https://blog.csdn.net/meiyouyaCSDN/article/details/94666048

版权

1 篇文章 0 订阅

订阅专栏

什么是RESTful API

REST 是 REpresentational State Transfer的缩写，它是一种分布式超媒体系统的架构风格。最初由Roy Fielding在2000年的论文中提出。其包含6个引导约束，具体查看官网的介绍。

下面说明一下RESTful API要如何应用到开发流程中去。

RESTful API总是使用HTTP(s)协议与用户通信。

在条件允许的情况下，尽量使用专用域名，如：https://api.demo.com，如果一定要使用主域名，就尽量保持如下格式：https://demo.com/api/。

应将API的版本放在URL中，如：https://api.demo.com/v2/xxx，这种方式最为直观。也可以将其放在HTTP请求的头信息中。推荐前者，简洁直观。

在RESTful风格中，每个资源路径都代表一种资源，所以应尽量使用名词，官网说是只能有名词，但是实际情况可能会有所局限，所以尽量使用名词。

HTTP动词用来表示对该资源进行何种操作。针对不同的操作，服务器会有相应的返回结果，这个结果也有一个大致的规范。

HTTP动词	对应的SQL命令	描述	结果规范
GET	SELECT	从服务器获取资源（一个或多个）	返回单个资源或其对象的列表（数组）
POST	INSERT	在服务器新建一个资源	返回新生产的资源对象
PUT	UPDATE	在服务器更新资源（客户端提供改变后的完整资源，包括未改变的）	返回完整的资源对象
PATCH	UPDATE	在服务器更新资源（客户端只提供改变的属性）	返回完整的资源对象
DELETE	DELETE	从服务器删除资源	返回空文档

还有一些如 HEAD、OPTIONS、CONNECT等不常用的HTTP动词

在RESTful风格中，应尽量使用HTTP status code来描述服务器的状态信息。

常见状态码如下：

由于业务逻辑需要，也可以自定义一些状态码用于返回，毕竟规矩是死的，只要原则不变，适用业务场景才是最重要的

对于服务端而言，如果状态码是 4xx，那么就应该向客户端返回错误信息。官方推荐用error为键名。

RESTful API为什么叫超媒体架构，因为其推荐在返回结果中提供指向其它API的链接（一般这个链接都是客户端要做的下一步操作），使得用户不需查文档就知道下一步应该做什么。

总的来说，RESTful API推崇的风格可以概括为三点：

通过三个简明扼要的点，清楚的反应了一系列的客户端–服务端交互操作，一定程度上，避免了干点啥、改点啥就要去查接口文档，就要去沟通。尤其是在前后端分离的情况下。前后端开发人员无须在接口上只需少量沟通成本，甚至零沟通成本。各自的开发效率都得到了大幅度提高。

关注