快速上手 RESTful API 开发的教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

随着移动互联网的逐渐普及,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


猜你喜欢

  • 构建无服务器应用程序的挑战和最佳实践

    随着云计算技术的迅速发展,越来越多的企业开始采用无服务器计算架构来构建应用程序。与传统的基于服务器的应用架构相比,无服务器计算最大的优势在于它不需要用户购买和维护服务器,而是将这些任务全部交给云服务提...

    11 天前
  • ECMAScript 2020 的模块全局变量问题的解决方法

    在开发前端项目时,我们经常会使用模块化的方式来管理代码。ECMAScript 2020 引入了新的模块全局变量,使得模块的使用更加方便和灵活。然而,这也带来了一些问题,如模块全局变量的命名冲突和代码维...

    11 天前
  • Angular 6 中的样式与 CSS 性能调优指南

    当我们开发前端应用时,对于样式与 CSS 性能的调优也是非常重要的。本文将为大家介绍如何在 Angular 6 中进行样式编写和 CSS 性能调优,以实现更好的用户体验。

    11 天前
  • webpack loader 详解

    在前端开发领域中,webpack 是一款非常流行的模块打包工具。除了能够将各种资源文件打包成一个或多个文件,还可以通过使用各种 loader 处理各种类型的文件,以便进行打包和构建。

    11 天前
  • 在 Jest 中使用 Cypress 测试端到端的页面

    对于前端开发人员来说,测试是一个非常重要的环节。在代码变得越来越复杂的同时,测试的覆盖率也变得越来越关键。 在这篇文章中,我们将介绍如何在 Jest 中使用 Cypress,以测试完整的端到端页面。

    11 天前
  • Express.js 跨域请求的解决方法

    在前端开发中,跨域请求是一个常见的问题。由于浏览器的同源策略限制,一个网页只能向同源的服务器发出Ajax请求,而不能与其它服务器进行通信。在实际开发中,我们常常需要通过Ajax请求与其它域名下的服务器...

    11 天前
  • Redis 实现分布式锁的技术实现

    前言 在分布式系统中,由于多台机器同时参与访问同一资源,为了保证数据的一致性,需要使用分布式锁来控制对共享资源的访问。Redis 作为一个高性能的缓存数据库,也可以用来实现分布式锁。

    11 天前
  • RxJS 中常见的 4 种减少 Observable 的 FlatMap 可能性

    RxJS 是一种强大的 JavaScript 库,用于处理异步数据流和源。在 RxJS 中,FlatMap 操作符允许我们将 Observable 转换为另一个 Observable,同时减少其中的嵌...

    11 天前
  • 利用 CSS3 和 jQuery 实现响应式设计导航

    利用 CSS3 和 jQuery 实现响应式设计导航 随着移动设备的普及,越来越多的用户开始使用手机和平板等移动设备浏览网页。在这种情况下,设计一个能够适应各种设备分辨率的响应式网站就成为了前端开发中...

    11 天前
  • Next.js 应用中使用 Prisma 来创建数据模型的方法

    在现代的 Web 应用中,使用数据库存储数据的需求日益增加。Prisma 是一个流行的数据库访问工具,它提供了强类型的数据访问 API,能够让开发者更加方便地访问数据库。

    11 天前
  • 如何在 Chai 中使用自定义 Error 类型进行断言

    在进行前端开发时,我们经常需要进行单元测试以验证代码的正确性。在单元测试中,使用断言来判断测试结果是否符合预期。 Chai 是一个流行的 JavaScript 断言库,它提供了多种断言风格,可以方便地...

    11 天前
  • 使用 GraphQL 查询数据集合的一些技巧

    GraphQL 是现代化的 Web 应用程序开发中的一个重要组件。它是一种查询语言,允许客户端灵活地指定自己需要的数据,同时减少了不必要的数据传输。在前端开发中,GraphQL 被广泛应用于查询 AP...

    11 天前
  • Redux 教程:从入门到实战

    前言 Redux 是一个流行的 JavaScript 应用程序状态管理工具。它提供了一种可预测的状态管理方法,以便我们在应用程序中轻松地处理数据流和状态管理。本文将详细介绍 Redux 的概念、工作原...

    11 天前
  • 解决 MongoDB 大数据删除慢的问题

    MongoDB 是目前最流行的 NoSQL 数据库之一,其高扩展性、高性能以及灵活的数据模型在互联网开发中被广泛使用。但是,随着数据量的增加,MongoDB 在删除大量数据时往往会变得非常慢,本文将介...

    11 天前
  • 如何在 Docker 容器中管理 SSL 证书?

    SSL证书在现代网络传输中扮演着非常重要的角色。但是,当我们使用 Docker 共同开发和部署 Web 应用程序时,如何管理 SSL 证书可能会成为一个挑战。因此,本文将向您介绍如何在 Docker ...

    11 天前
  • PWA 应用中的社交分享功能:技术实现和最佳实践

    近年来,随着 PWA(Progressive Web Apps)应用的流行,PWA应用中的社交分享功能也逐渐受到了关注。社交分享功能能够让用户更轻松地将网页内容分享到社交网络上,以便更多的人了解和使用...

    11 天前
  • 使用 Fastify 和 OAuth 实现第三方登录

    在 Web 开发中,第三方登录功能已经成为了必不可少的一部分,因为这项功能可以帮助用户快速注册和登录,同时也是提高用户体验的一种方式。在本文中,我们将介绍如何使用 Fastify 和 OAuth 实现...

    11 天前
  • PM2 自定义日志保存及清理策略

    前言 随着 JavaScript 在前端的应用日益广泛,越来越多的前端开发者开始意识到需要将工具栈向后端延伸,学习一些后端开发的知识。PM2 是 Node.js 的进程管理工具,支持自定义日志保存及清...

    11 天前
  • 如何解决 CSS Reset 对字体颜色的影响

    在网页开发中,我们经常使用 CSS Reset 来解决浏览器之间样式的兼容性问题。但是,CSS Reset 会导致字体颜色出现问题,使得页面呈现出一片白色,影响用户体验。

    11 天前
  • 如何使用 Docker 容器进行 RESTful API 的部署

    前言 RESTful API 成为现代化 Web 开发的重要部分,在企业和云端应用之间传输信息时无处不在。在这篇文章中,我们将向您展示如何使用 Docker 容器技术来部署 RESTful API,并...

    11 天前

相关推荐

    暂无文章