随着前端技术的不断发展,前后端分离已经成为了越来越多的开发者的选择,而搭建 RESTful API 也是不可或缺的一部分。在本文中,我们将会介绍如何使用 Deno 和 MongoDB 搭建一个简单的 RESTful API,并且会提供详细的代码示例和使用说明。
Deno 是什么
首先,我们需要了解一下 Deno 是什么。Deno 是一个由 Node.js 的创始人 Ryan Dahl 开发的运行时环境,用于在服务器端和客户端执行 JavaScript 和 TypeScript 代码。它的目标是创建一个更安全、更简单的 JavaScript 运行环境,可以更好地与现代 Web 编写工具协作。
与 Node.js 不同的是,Deno 内置了一些常用的功能,如 TypeScript 编译器、Async/Await、ES modules 和 Promise,并且不需要添加额外的库和包管理器。此外,Deno 也带有安全性的增强功能,支持沙箱执行和权限机制,可以限制代码访问文件系统和网络等资源。可以看出,Deno 是一个更加现代、全面和安全的 JavaScript 运行时环境。
MongoDB 是什么
MongoDB 是一个面向文档的 NoSQL 数据库,它使用 BSON 存储格式(Binary JSON)。与传统的关系型数据库不同,MongoDB 可以轻松地存储和查询非结构化数据,如 JSON 格式的数据。它可以扩展到海量数据和高并发访问,并且支持副本集和分片集群等高可用性方案。
除了这些通用的数据库功能外,MongoDB 还提供了一些专用于 Web 开发的功能,如地理位置索引、全文搜索和图形搜索,并且支持多语言和多个平台上的客户端驱动程序。在本文中,我们将使用 MongoDB 存储并查询我们的 RESTful API 数据。
搭建 RESTful API
接下来,我们将会简单地讲解如何使用 Deno 和 MongoDB 搭建 RESTful API,我们将会使用 Oak 中间件作为 HTTP 服务器,使用 MongoDB 数据库进行数据的存储和查询。
安装依赖
首先,我们需要安装一些依赖,包括官方的 Deno 命令行工具和第三方的 Oak 运行时和 MongoDB 驱动程序。你可以通过以下命令进行安装。
# 安装 Deno $ curl -fsSL https://deno.land/x/install/install.sh | sh # 安装 oak 运行时和相关依赖 $ deno install --allow-net --allow-read --allow-env --allow-write --unstable https://deno.land/x/oak/mod.ts # 安装 MongoDB 驱动程序 $ deno install --allow-net --allow-read --allow-write --unstable https://deno.land/x/mongo/mod.ts
创建服务器
现在,我们可以开始创建一个 HTTP 服务器。在这个服务器上,我们将会构建各种 API 端点,并对请求做出响应。
我们将会创建一个名为 server.ts
的文件,并添加以下代码:
-- -------------------- ---- ------- ------ - ------------ ------ - ---- --------------------------------- ------ - ----------- - ---- ----------------------------------- ------ ------------------------------------- -- -- ---- -- ----- --- - --- -------------- ----- ------ - --- --------- --------------- ----- -- - ----------------- - ------- -------- --- ------------------------- --------------------------------- ---------------------- -- ---- ---------------------- -- -------- ----- ------------ ----- --------------------------- -- ----- ---
在这个文件中,我们首先导入了 Oak 中间件和 MongoDB 驱动程序,并解析了 .env
文件以获取环境变量。然后,我们创建了一个 HTTP 应用程序和一个路由器,并定义了一个简单的 /
端点,用于测试服务器是否运行。
最后,我们启动了服务器,并指定监听的端口,默认为 8000。
连接 MongoDB
在上面的代码中,我们导入了 MongoDB 驱动程序,但我们还没有连接到 MongoDB。现在让我们来连接到 MongoDB 数据库,以便能够使用它储存和查询数据。
我们将继续使用 server.ts
文件,并添加以下代码:
-- -------------------- ---- ------- ----- ------ - --- -------------- ----- ------------------------------------------ -- ---- ----- -- - ------------------------------------------------ -- -------- ----- ----- - ----------------------- -------------------- ----- ----- -- - ----------------- - ----- ------------- ---
在这个代码块中,我们首先创建了一个 MongoDB 客户端,然后使用 Deno.env.get()
方法获取 .env
文件中的 MongoDB 连接 URI 和数据库名称。接下来,我们连接到数据库,并获取了一个 users
集合,将在之后的端点中用到。
我们还添加了一个 GET 端点 /users
,用于查询所有用户的数据。我们使用 await users.find()
查询所有文档,并将结果直接返回给客户端。
添加用户
现在,我们已经连接到 MongoDB,下一步是创建一个 POST 端点,用于添加用户的数据。
我们将继续使用 server.ts
文件,并添加以下代码:
-- -------------------- ---- ------- --------------------- ----- ----- -- - ----- ---- - ----- ------------------------- ----- - ----- --- - - ----- ----- ------ - ----- ----------------- ----- ---- ---------- --- ------- --- ----------------- - ------- ------------------- - ---- ------------------------------------ ------------------------------- ---
在这个代码块中,我们添加了一个 POST 端点 /users
,用于实现添加用户数据的功能。我们使用 ctx.request.body().value
获取客户端发送的请求正文,并解构 name
和 age
等数据。
接下来,我们使用 users.insertOne()
方法将数据插入到 MongoDB 中。在成功插入数据后,我们返回了一个结果对象给客户端,同时设置 201 状态码和指向新创建的用户数据的数据的资源 URL。
获取单个用户
现在,我们已经可以查询所有用户的数据并添加用户的数据,下一步是添加一个 GET 端点,用于查询单个用户的数据。
我们将继续使用 server.ts
文件,并添加以下代码:
-- -------------------- ---- ------- ------------------------ ----- ----- -- - ----- ---- - ----- --------------- ---- - ----- ------------- - --- -- ----- --- ----- - ------------------- - ---- ----------------- - - -------- ----- --- ------ -- - ---- - ----------------- - ----- - ---
在这个代码块中,我们添加了一个 GET 端点 /users/:id
,用于查询单个用户的数据。我们使用 await users.findOne()
方法查询匹配 _id
的文档,并使用 $oid
转换字符串到 ObjectID 对象。
如果查询结果为 null
,说明根据 ID 没有找到任何数据,我们设置响应的状态码为 404,并返回一个包含错误信息的对象。否则,我们直接返回查询到的用户数据。
更新用户
现在,我们已经可以查询所有用户数据、添加用户数据和查询单个用户数据,下一步是添加一个 PUT 端点,用于更新用户的数据。
我们将继续使用 server.ts
文件,并添加以下代码:
-- -------------------- ---- ------- ------------------------ ----- ----- -- - ----- ---- - ----- ------------------------- ----- - ----- --- - - ----- ----- ------ - ----- ---------------- - ---- - ----- ------------- - -- - ----- - ----- --- - - -- -- -------------------- --- -- - ------------------- - ---- ----------------- - - -------- ----- --- ------ -- - ---- - ----------------- - ------- - ---
在这个代码块中,我们添加了一个 PUT 端点 /users/:id
,用于更新单个用户的数据。我们使用 ctx.request.body().value
获取客户端发送的请求正文,并解构 name
和 age
等数据。
接下来,我们使用 users.updateOne()
方法查询匹配 _id
的文档,并将 name
和 age
等数据作为更新后的值。在更新成功后,我们将返回一个结果对象给客户端,否则设置 404 状态码并返回一个包含错误信息的对象。
删除用户
最后,我们添加一个 DELETE 端点,用于删除单个用户的数据。
我们将继续使用 server.ts
文件,并添加以下代码:
-- -------------------- ---- ------- --------------------------- ----- ----- -- - ----- ------ - ----- ----------------- ---- - ----- ------------- - --- -- -------------------- --- -- - ------------------- - ---- ----------------- - - -------- ----- --- ------ -- - ---- - ------------------- - ---- - ---
在这个代码块中,我们添加了一个 DELETE 端点 /users/:id
,用于删除单个用户的数据。我们使用 users.deleteOne()
方法查询匹配 _id
的文档,并将其删除。
在删除成功后,我们将设置状态码为 204,并且不返回任何响应正文。如果没有匹配的文档,我们设置状态码为 404,并返回一个包含错误信息的对象。
测试 API
现在,我们已经创建了所有的 RESTful API 端点。为了测试它们是否正常工作,我们使用 deno run
命令运行 server.ts
文件,并使用工具如 Postman 来测试测试 API 接口是否是有响应的。你也可以访问 localhost:8000
确认服务器是否在运行。
总结
在本文中,我们介绍了如何使用 Deno 和 MongoDB 搭建一个简单的 RESTful API,在其中学习了如何使用 Oak 中间件、连接到 MongoDB 数据库以及构建各种 API 端点。同时,我们了解了如何使用 Deno 的优点,如支持 TypeScript、内置 Async/Await、ES modules 和 Promise 等。
当然,本文只介绍了搭建一个简单的 RESTful API 的流程,很多细节和安全考虑都没有提及。对于更大型的应用程序来说,可能需要更复杂的服务器和更多的功能实现。此外,使用 MongoDB 时,安全问题也需要格外注意。虽然 MongoDB 支持在不暴露端口的情况下在本地运行,但如果没有正确的配置,任何人都可以访问你的数据库。
在实际开发中,你需要多考虑一些不同的方面,如算法、云计算、软件设计等。希望本文能够对你理解如何使用 Deno 和 MongoDB 搭建 RESTful API 有所帮助,并且启发你更多的思考。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64e2d652f6b2d6eab3e204b6