Deno 实战:使用 Deno 构建 RESTful API

阅读时长 8 分钟读完

随着 Node.js 不断发展,JavaScript 成为了前端界的一首独角戏。但是 Node.js 作为老将,其存在着许多已经无法改变的问题,例如模块管理、包管理等等。出现的 Deno(Denno.js 的简称)就是对 Node.js 一个全新的尝试,它不仅拥有 Node.js 所有特性,而且将更先进、更方便的功能集成在其中。在本文中,我们将教您如何使用 Deno 构建一个 RESTful API,带您深入学习 Deno.js 的强大功能。

Deno.js 简介

Deno.js 是一个由 Node.js 的创始人 Ryan Dahl 发起的新型服务器端运行时环境,集成 TypeScript 解释器、V8 引擎和 Web APIs,以及 Rust 而不是 C++ 的后端工具链。与 Node.js 不同的是,Deno 内置了许多操作系统所提供的实用功能;同时它也去除了 Node.js 中令人头疼的问题,例如全局环境变量、Node.js 中的 callback hell、事件驱动等等。

与 Node.js 一样,Deno 也支持异步 I/O,但 Deno 依赖了更为高级的 async/await 机制,这类开发风格使得我们能够使用更加强大的语言特性,减少了开发过程中的繁琐,提高了代码的可读性和可维护性。

RESTful API

RESTful API 是现代 Web 开发中最广泛使用的一种 API 设计风格,简单说就是基于 HTTP 协议的一种 API 设计风格。它将资源映射为 HTTP 使用的 URIs,使用 HTTP 方法(例如 GET、POST、PUT、DELETE)来实现对资源的操作。

一个标准的 RESTful API 通常由以下部分组成:

  • 资源:RESTful API 将所有的数据封装成资源,通过 URL 确认唯一性(例如 GET /users)。
  • 方法:使用 HTTP 方法来操作资源,常见方法有 GET、POST、PUT、DELETE。
  • 状态码:表示请求执行的状态,例如 200 OK、404 Not Found。
  • 数据格式:RESTful API 支持多种数据格式,例如 JSON、XML。
  • 标准的 URI 路径格式:由小写字母和下划线构成,单词之间以短横线分割。

了解基本的 RESTful API 设计原则非常有益,在后续构建 API 时能够大量减少出错,提高开发效率。

Deno.js 构建 RESTful API

在这篇文章中,我们将使用 Deno.js 来构建一个简单的 RESTful API。我们将尝试构建一个包含用户信息的资源,它可以实现用户的添加、修改和删除。首先,我们需要安装 Deno.js,这里不再赘述具体安装步骤。

初始化一个 Deno.js 项目

首先在命令行上创建并切换到我们的项目目录:

接着,我们需要在命令行上输入以下命令来初始化我们的 Deno 项目:

这里我们给了我们程序一些特殊权限以确保正常运行。

接下来,我们需要使用编辑器打开 index.ts 文件,并编写以下代码:

-- -------------------- ---- -------
------ - ----------- - ---- --------------------------------

----- --- - --- -------------

----- ---- - ----

----------- -- -
  ----------------- - ------ -------
--

------------------- ------- -- ---- ---------

----- ------------ ----- ---- --
展开代码

在这段代码中,我们首先引入并使用了 Deno 的标准模块 oak。然后,我们监听了 8000 端口,并返回了一个 "Hello World!" 字符串。最后,我们在控制台输出了一个运行提示。运行 deno run --allow-net src/index.ts,我们就可以在浏览器上看到 "Hello World!"。

接下来,我们将增加一些接口以便展示我们的用户资源。我们将把它们放到一个单独的文件夹 src/api 中,以便更好地组织我们的代码。

接着,我们使用 oak 来创建一个 RESTful API,让我们来看一下如何实现。

RESTful API 实现

首先,我们需要在 users.ts 中定义我们的用户模型:

我们将用户模型定义为一个类型接口,以确保我们在开发过程中使用强类型。

接下来我们实现 GET 请求来获取用户的信息。我们需要在 src/api/users.ts 中添加以下代码:

-- -------------------- ---- -------
------ - ------ - ---- --------------------------------

----- ------ - --- --------

----- ------ ----------- - -
  -
    --- ----
    ----- ----- -----
    ---- ----
  --
  -
    --- ----
    ----- ----- -----
    ---- ----
  -
-

-------------------- ----- -- -
  ----------------- - -----
--

------ ------- ------
展开代码

在这段代码中,我们使用 oak 中的路由功能来将 /users 路径映射到我们创建的路由器实例 router。当客户端发起 GET 请求时,路由器会将 users 数组返回给客户端,让客户端可以看到我们添加的所有用户的信息。

接下来,我们需要实现 POST 请求来将新用户添加到我们的应用中。我们在 src/api/users.ts 中添加以下代码:

-- -------------------- ---- -------
--- ------ - -

--------------------- ----- ----- -- -
  ----- ---- - ----- ------------------

  ------- - ----------------
  ----------------

  ------------------- - ---
  ----------------- - ----
--
展开代码

在这段代码中,我们附加了一个新的路由来处理 POST /users 请求。当客户端发起 POST 请求时,我们会将新用户保存到我们的 users 数组中,并且将新添加的用户返回给客户端。

接下来,我们将实现 DELETE 请求来从我们的应用中删除用户。我们在 src/api/users.ts 中添加以下代码:

-- -------------------- ---- -------
--------------------------- ----- -- -
  ----- - -- - - ----------

  ----- --------- - ---------------------- -- ------- --- ---

  -- ---------- --- --- -
    ----------------------- --
    ------------------- - ---
  - ---- -
    ------------------- - ---
  -
--
展开代码

在这段代码中,我们使用了路由器的 DELETE 方法来处理客户端发送的 DELETE 请求。当客户端发起 DELETE 请求时,我们会将要删除的用户 ID 从 URL 中解析,然后在 users 数组中删除这个用户。

最后,我们将实现 PUT 请求来更新用户信息。我们在 src/api/users.ts 中添加以下代码:

-- -------------------- ---- -------
------------------------ ----- ----- -- -
  ----- ---- - ----- ------------------
  ----- - -- - - ----------

  ----- --------- - ---------------------- -- ------- --- ---

  -- ---------- --- --- -
    ---------------- - -
      --------------------
      --------
    -

    ----------------- - ----------------
  - ---- -
    ------------------- - ---
  -
--
展开代码

在这段代码中,我们使用了路由器的 PUT 方法来处理客户端发送的 PUT 请求。PUT 请求主要用于更新已经存在的资源。当客户端发起 PUT 请求时,我们会解析 URL 中的用户 ID,并使用请求中的数据更新应用程序中的用户信息。

测试 Deno.js API

现在,我们已经完成了我们的 RESTful API,可以使用 deno run --allow-net --allow-env --allow-read --allow-write src/index.ts 来启动服务器。现在,使用 curl 命令或其他工具测试我们的 API!

总结

本文为您提供了 Deno.js 和 RESTful API 的详细介绍。我们使用 oak 库来创建 RESTful API,包括添加、修改和删除一个简单的用户资源。掌握 Deno.js 将为您打开全新的 Web 开发世界,可以更加方便、高效地实现复杂的项目。请务必尝试在熟练掌握后在您的项目中使用 Deno.js 来提高代码的可维护性和开发效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64951c4648841e9894263db0

纠错
反馈

纠错反馈