用node.js和express代码您的第一个API：了解REST API

REST 和 RESTful API 简介

在现代 Web 开发中，你一定经常遇到 REST 和 API 这些术语。如果你听说过这些术语或使用过 API，但并不完全了解它们的工作原理或如何构建自己的 API，那么本系列教程正适合你。

本教程系列将首先概述 REST 原则和概念。然后，我们将创建一个在 Node.js Express 服务器上运行并连接到 MySQL 数据库的完整 API。完成本系列教程后，你应该能够自信地构建自己的 API 或深入研究现有 API 的文档。

先决条件

为了充分利用本教程，你应该具备一些基本的命令行知识，了解 JavaScript 的基础知识，并在全局安装了 Node.js。

REST 和 RESTful API 是什么？

表述性状态转移 (REST) 描述了一种 Web 服务的架构风格。REST 包含一组用于在不同系统之间共享数据的标准或约束，实现 REST 的系统被称为 RESTful。REST 是一个抽象概念，而不是一种语言、框架或软件类型。

一个关于 REST 的松散类比是：保留黑胶唱片收藏与使用流媒体音乐服务。对于物理黑胶唱片收藏，必须完整复制每张唱片才能共享和分发副本。然而，对于流媒体服务，可以通过对某些数据（例如歌曲标题）的引用来永久共享相同的音乐。在这种情况下，流媒体音乐是一种 RESTful 服务，而黑胶唱片收藏是一种非 RESTful 服务。

API 是应用程序编程接口，它是一个允许软件程序相互通信的接口。RESTful API 只是一个遵循 REST 原则和约束的 API。在 Web API 中，服务器通过 URL 端点接收请求，并返回响应，响应通常是 JSON 格式的数据。

REST 原则

六个指导性约束定义了 REST 架构，如下所示：

1. 统一接口: 组件的接口必须相同。这意味着使用 URI 标准来标识资源——换句话说，可以输入到浏览器地址栏中的路径。
2. 客户端-服务器: 服务器（存储和操作数据）和客户端（请求和显示响应）之间存在关注点分离。
3. 无状态交互: 关于每个请求的所有信息都包含在每个单独的请求中，并且不依赖于会话状态。
4. 可缓存: 客户端和服务器可以缓存资源。
5. 分层系统: 客户端可以连接到最终服务器，或中间层，例如负载均衡器。
6. 按需代码 (可选): 客户端可以下载代码，从而减少外部可见性。

请求和响应

你可能已经熟悉了所有网站的 URL 都以 https 开头（安全版本）。超文本传输协议 (HTTP) 是互联网上客户端和服务器之间通信的方法。

我们最明显地看到它在浏览器的 URL 栏中，但 HTTP 不仅可以用于从服务器请求网站。当你访问 Web 上的 URL 时，你实际上是在执行 GET 和其他类型的请求。

HTTP 通过打开到服务器端口 (http、https) 的TCP (传输控制协议) 连接来发出请求，监听服务器会返回状态和正文。

请求必须包含 URL、方法、标头信息和正文。

请求方法

有四种主要的 HTTP 方法，也称为 HTTP 动词，通常用于与 Web API 交互。这些方法定义了将对任何给定资源执行的操作。

HTTP 请求方法大致对应于CRUD 范例，CRUD 代表 创建、更新、读取、删除。尽管 CRUD 指的是数据库操作中使用的函数，但我们可以将这些设计原则应用于 RESTful API 中的 HTTP 动词。

<code>curl -i https://www.google.com</code>

Google 的服务器将返回以下内容：

<code>HTTP/2 200
date: Sun, 21 Aug 2022 19:06:22 GMT
expires: -1
cache-control: private, max-age=0
content-type: text/html; charset=ISO-8859-1
...</code>

我们可以看到 200 状态代码，以及 HTTP 的版本（这将是 HTTP/1.1、HTTP/2 或 HTTP/3）。

由于此特定请求返回的是网站，因此为 text/html。在 RESTful API 中，你可能会看到对 Google 的 curl 请求（不包含 google.com）返回 301 响应，以指示应重定向资源。

REST API 端点

当在服务器上创建 API 时，它包含的数据可以通过端点访问。端点是可以接受和处理 POST、DELETE 请求的请求的 URL。

API URL 将由根、路径和可选查询字符串组成。

• 根 例如 https://www.php.cn/link/9efa87e164995a7743eca9ad63029fa4 的根，可能包含协议、域名和版本。
• 路径 例如 /users/5：特定资源的唯一位置。
• 查询参数 (可选) 例如 limit=10，用于将响应过滤为仅包含十个结果。

例如，要获取 ID 为 5 的用户，我们将使用 /user/5。

REST API 约定

以下是构建 RESTful API 时应遵循的一些约定：

• 端点不应显示文件扩展名: 尽管 API 最有可能返回 JSON，但 URL 不应以 .json 结尾。
• 使用名词而不是动词: 例如，要添加用户，我们应该使用 /users 端点并使用 POST 请求，而不是使用 /users/add 端点。API 应该开发为能够处理对同一 URL 的多种类型的请求。
• 路径区分大小写，应使用小写字母和连字符而不是下划线: 例如，/users-list 比 /users_list 更可取。

所有这些约定都是指导原则，因为没有严格的 REST 标准可供遵循。但是，使用这些指导原则将使你的 API 一致、熟悉且易于阅读和理解。

REST 的替代方案

REST 是一种很棒的工具，但有一些替代方案可以在某些情况下提供帮助。

SOAP

SOAP（简单对象访问协议）是 1998 年创建的 API，在 REST 之前非常流行。它们之间存在一些主要区别。首先，SOAP 对响应格式的限制要严格得多。其次，SOAP 使用 XML 而不是 JSON，这对于遗留应用程序可能很有用，但通常比等效的 JSON 更大更复杂。最后，虽然 SOAP 可以很好地与 HTTP 配合使用，但它也支持 SMTP 等协议。

GraphQL

GraphQL 是 Facebook 创建的一种较新的 API 格式，它旨在通过允许客户端准确地告诉服务器它需要什么数据来减少获取数据所需的 HTTP 请求数量。GraphQL 不使用 URL 路径，而是具有自定义语法来定义客户端需要什么数据，以便客户端在一个请求中获得所需的一切。

有关 GraphQL 的精彩介绍，请查看本 GraphQL 教程。

结论

在本文中，我们学习了 REST 和 RESTful API 是什么，HTTP 请求方法和响应代码如何工作，API URL 的结构以及常见的 RESTful API 约定。在下一教程中，我们将学习如何通过使用 Node.js 设置 Express 服务器并构建我们自己的 API 来将所有这些理论付诸实践。

本文已更新，并包含 Jacob Jackson 的贡献。Jacob 是一位 Web 开发人员、技术作家、自由职业者和开源贡献者。

以上是用node.js和express代码您的第一个API：了解REST API的详细内容。更多信息请关注PHP中文网其他相关文章！