随着移动互联网的逐渐普及，Web API 的需求越来越大。RESTful API 是当前最受欢迎的 Web API，它具有基于 HTTP 协议、采用标准的 URI 和 HTTP 方法等多方面的特点，使得它具有简单、易扩展和安全等优点。本篇文章将针对初学者，介绍 RESTful API 开发的基础知识和最佳实践。
RESTful API 的基础知识
RESTful（Representational State Transfer）是一种架构风格，它是一种面向资源的设计理念。它主要包括以下几个要素：
- 资源（Resources）：要提供服务的一些对象，例如用户、商品。
- 动作（Actions）：针对资源进行的操作，例如获取、创建、更新、删除资源。
- 表示（Representations）：资源的表现形式，例如 JSON、XML。
- URI（Uniform Resource Identifier）：通过 URI 来访问资源。
- HTTP 方法：通过 HTTP 方法来进行资源操作。
RESTful API 是基于 RESTful 设计理念的 Web API。它支持一组标准的 URL 和 HTTP 协议方法，例如 GET、POST、PUT 和 DELETE，这些方法通常被用来创建、读取、更新和删除（CRUD）资源。
开发 RESTful API
设计 API
在开始 RESTful API 的开发之前，你需要关注设计。你需要考虑要提供哪些资源，以及用户如何访问这些资源。一个好的 API 设计需要满足以下条件：
- 可读性：API 应该能够被人理解，并且易于使用。
- 可扩展性：API 应该能够支持新的数据类型和功能，而不破坏现有的功能。
- 稳定性：API 应该是稳定的，并且不会破坏现有的用户。
你可以参考其他公司的 API 设计，例如 Twitter、Facebook 等流行社交网站的 API 设计。
实现 API
一旦您完成了设计，您就可以开始实现 RESTful API。您可以使用任何后端技术来实现 RESTful API，例如 Node.js、Rails 或 Django 等。不过这里我们将以 Node.js 为例，介绍具体的实现方法。
我们将使用 Node.js 框架 Express.js 来实现一个简单的 RESTful API。我们的 API 提供了一个 book 资源，并支持 GET、POST、PUT 和 DELETE 操作。
安装 Express.js
打开终端，输入以下命令：
- --- ------- ------- ------
创建项目
创建一个新的文件夹并以这个文件夹为工作目录。打开一个命令行窗口，先输入以下命令，用于初始化 npm：
- --- ----
接着，按照提示输入名称、版本号等信息。最后，运行以下命令以安装 Express.js：
- --- ------- ------- ------
编写代码
开始编写代码。在工作目录下，我们创建一个新的文件 index.js，输入以下代码：
----- ------- - ------------------- ----- ---------- - ----------------------- ----- --- - ---------- ------------------------------- --------- ---- ---- --------------------------- --- ----- - - - --- -- ------ -------- -- ------- -- - --- -- ------ ------------ --- ---- ------ - -- ----------------- ----- ---- -- - ---------------- --- ------------------ ----- ---- -- - ----- ---- - --------- ----------------- ------- - ------------- --------------- --- --------------------- ----- ---- -- - ----- -- - ----------------------- ---- ----- ---- - --------- ----- ----- - ----------------- -- ---- --- ---- ------------ - ----- --------------- --- ------------------------ ----- ---- -- - ----- -- - ----------------------- ---- ----- ----- - ----------------- -- ---- --- ---- ------------------- --- ---------- -------- ----- -------- --- --- ---------------- -- -- - ------------------- -- ------- -- ---- ------- ---
这段代码创建了一个 Express.js 应用程序，使用 json 中间件来处理请求和响应。然后，我们声明了一个本地变量 books，来存储书籍数据。
接下来，我们声明了四个路由处理函数，它们对应了四个 HTTP 方法，分别是 GET、POST、PUT 和 DELETE。这些方法分别用于获取、创建、更新和删除书籍资源。其中，GET 方法是获取所有书籍的列表；POST 方法用于创建一个新的书籍；PUT 用于更新一本书籍；DELETE 方法用于删除一本书籍。
最后，我们使用 app.listen() 方法启动 Express.js 应用程序，并监听 3000 端口。当应用程序启动后，我们将显示一条消息：'Server is running on port 3000'。
测试 API
我们已经编写并启动了 RESTful API。现在我们需要测试它。您可以使用 Postman 来测试 RESTful API。
首先，我们要测试 GET 方法，打开 Postman，输入以下 URL：http://localhost:3000/books，选择 GET 方法，并单击 Send 按钮：
上图中，我们得到了两个书籍的列表，这是 GET 方法的返回结果。
接下来，我们测试 POST 方法。单击 Postman 工具栏上的 “Body” 标签，输入以下 JSON 代码：
- -------- -------- --- --------- -
接着，单击 Send 按钮。
上图中，我们成功地向 books 数组添加了一条新记录，并返回了这个新添加的记录。这是 POST 方法的返回结果。
接着，我们要测试 PUT 方法，单击 Postman 工具栏上的 “Body” 标签，输入以下 JSON 代码：
- -------- -------- --- --------- -
接着，我们将 /books/1 添加到 URL 输入框中，并选择 PUT 方法，单击 Send 按钮。
上图中，我们成功地更新了 id 为 1 的书籍，并返回了更新后的记录。这是 PUT 方法的返回结果。
最后，我们测试 DELETE 方法。在 URL 输入框中输入 /books/1，选择 DELETE 方法，然后单击 Send 按钮。
上图中，我们成功地从 books 数组中删除了第一条记录，并返回了消息：'Book deleted'。这是 DELETE 方法的返回结果。
恭喜！我们已经成功地完成了一个简单的 RESTful API 应用程序。
API 安全性
API 安全性是任何 Web 应用程序的一个重要方面。您应该保护 API 免受攻击。下面是几个常见的 API 安全方法：
- 使用 SSL/TLS：通过使用 SSL/TLS 保护 RESTful API 中的重要数据，可以确保数据加密并通过双向认证来保障通讯安全。
- 使用 OAuth2：OAuth2 是一个授权协议，它允许第三方应用程序以受控的方式访问用户的资源。
- 使用限制速率策略：对于公开的 API，可以使用限制速率策略来防止滥用 API 的行为。
- 输入验证：输入验证可以确保我们的 API 不会受到不合法的数据攻击。
如果您想学习更多关于 API 安全性的知识，可以使用 Open Security Training 平台，该平台提供了大量免费的网络安全课程。同时，您也可以使用 apiary.io 等开发工具来快速地构建和测试 RESTful API。
结论
本篇文章介绍了 RESTful API 的基础知识和最佳实践。我们介绍了如何设计和实现 RESTful API，并提供了一个简单的 Node.js 示例。我们还讨论了一些常见的 API 安全策略。阅读本文后，您应该能够快速上手 RESTful API 开发，并了解如何保障 API 安全。
我们希望这个教程对您有所帮助。如果您有任何问题或反馈，请在评论区留言！
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/671edc882e7021665efa2b79