RESTful API：定义以及与传统 API 的对比

RESTful API 是一种基于 HTTP 协议的 API 设计风格，它的设计理念是以资源为中心，通过 HTTP 请求对资源进行增删改查。RESTful API 与传统 API 设计风格相比，具有很多优点，本篇文章将详细介绍 RESTful API 的定义及与传统 API 的对比。

RESTful API 的定义

RESTful API 是一种基于 HTTP 协议的 API 设计风格，它包括以下几个核心概念：

• 资源（Resource）：每个 URL 代表一种资源。
• 动作（Verb）：HTTP 协议提供的动词有 GET、POST、PUT、DELETE 等。
• 表现层（Representation）：资源以某种表现形式呈现，可以是 JSON、XML、HTML、二进制数据等。
• 状态转移（State Transfer）：客户端通过 HTTP 请求对资源进行增删改查，服务器发回响应以表明对请求的处理结果。

RESTful API 设计风格的优点是，它具有可读性、可扩展性和可维护性等优点。

RESTful API 与传统 API 的对比

传统 API 设计风格是基于过程的，它把方法暴露给客户端调用，例如：

def getUserInfo(userId):
    # 返回用户信息

在这种设计风格下，每个方法的调用都对应着一个 URL，客户端需要记住每个 URL 的作用和调用方法。

而 RESTful API 设计风格的 URL 是基于资源的，例如：

https://example.com/users/123

在这个 URL 中，“users” 是资源，“123” 是该资源的 ID。客户端通常只需记住资源的名称和操作，而不需要记住每个操作的 URL。

除此之外，RESTful API 设计风格还具有 URL 规范性、缓存、分层、可扩展等优点，使它更加适合大规模应用开发。

RESTful API 示例

下面是一个简单的 RESTful API 示例，用于查询和更新用户信息。

查询用户信息

请求：

GET https://example.com/users/123

响应：

{
    "userId": 123,
    "userName": "Tom",
    "userEmail": "tom@example.com",
    "userAge": 18
}

更新用户信息

请求：

PUT https://example.com/users/123
Content-Type: application/json

{
    "userEmail": "tom@example.com",
    "userAge": 20
}

响应：

HTTP/1.1 200 OK

结论

RESTful API 是一种基于 HTTP 协议的 API 设计风格，具有可读性、可扩展性和可维护性等优点。它与传统 API 的差异在于，它基于资源，而传统 API 基于过程。使用 RESTful API 设计风格可以使 Web 应用的开发更加简洁和可靠。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67750cc76d66e0f9aaf341c1