Deno 是一个新兴的 JavaScript / TypeScript 运行时,它能够运行在浏览器和服务器端。Deno的开发者 Ryan Dahl 曾经是 Node.js 的创造者,Deno 以其更安全的机制和更好的性能而备受瞩目。
在本文中,我们将介绍如何使用 Deno 来构建 REST API。REST(Representational State Transfer)是一种基于 HTTP 协议的 Web 服务架构,它使用 GET、POST、PUT、DELETE 等 HTTP 请求来获取或修改数据,具有简单、轻量级、可扩展等优点,是现代 Web 开发中的重要组成部分。
环境准备
首先,我们需要安装 Deno。如果你使用的是 macOS 或 Linux,可以使用以下命令安装:
curl -fsSL https://deno.land/x/install/install.sh | sh
如果你使用的是 Windows,可以使用以下命令安装:
iwr https://deno.land/x/install/install.ps1 -useb | iex
安装完成后,可以使用以下命令验证:
deno --version
此外,我们还需要一个编辑器,例如 Visual Studio Code,并安装 Deno 插件。
创建 REST API
接下来,我们将创建一个简单的 REST API,用于管理一个待办事项列表。我们将使用以下技术:
- Oak - 一个用于构建 Web 应用的 Deno 框架。
- MongoDB - 一个流行的 NoSQL 数据库。
首先,创建一个新的目录,并在其中创建一个名为 main.js 的文件。然后,安装 oak 和 mongodb 驱动程序:
deno install --allow-net --allow-read https://deno.land/x/oak/mod.ts deno install --allow-net https://deno.land/x/mongo/mod.ts
添加待办事项
在 main.js 中添加以下代码:
-- -------------------- ---- ------- ------ - ------------ ------ - ---- --------------------------------- ------ - ----------- - ---- ----------------------------------- ----- --- - --- -------------- ----- ------ - --- --------- ----- ------ - --- -------------- --------------------------------------------------- ----- -- - ------------------------- ----- ----- - ----------------------- --------------- ----- -- - ----------------- - ------ ------- --- -------------------- ----- ----- -- - ----- ------- - ----- --------------- ----------------- - -------- --- --------------------- ----- ----- -- - ----- - ----- - - ----- ------------------- ----- ---- - ----- ----------------- ----- ---------- --- ----------------- - ----- --- ------------------------- ----- ------------ ----- ---- ---
首先,我们导入了 oak 和 mongo 驱动程序,并创建了一个应用程序和路由。
然后,我们连接到 MongoDB 数据库,并从中获取 collection 对象。我们将在此集合中存储待办事项。
接下来,我们定义了三个路由:
- GET /:返回 "Hello Deno!" 的字符串。
- GET /todos:查询所有待办事项,并返回一个 JSON 数组。
- POST /todos:从请求正文中获取待办事项的文本,并将其插入到 MongoDB 中。
最后,我们将路由添加到应用程序中,并侦听 8000 端口。
在命令行中运行以下命令启动应用程序:
deno run --allow-net --allow-read main.js
现在,可以使用 HTTP 工具(例如 cURL 或 Postman)向应用程序发送请求并测试 API。例如,发送 POST 请求:
curl -X POST -d '{"text":"Buy milk"}' http://localhost:8000/todos
应该会收到以下响应:
{"$oid":"6078a83cb9f9b50008ddd109"}
这是在 MongoDB 中插入的文档的 ObjectID。接下来,发送 GET 请求:
curl http://localhost:8000/todos
应该会收到以下响应:
[{"_id":{"$oid":"6078a83cb9f9b50008ddd109"},"text":"Buy milk"}]
这是我们在 MongoDB 中插入的待办事项。
删除待办事项
我们还可以添加一个 DELETE 路由来删除待办事项。在 main.js 中添加以下代码:
router.delete("/todos/:id", async (ctx) => { const id = ctx.params.id; const count = await todos.deleteOne({ _id: { $oid: id } }); ctx.response.body = { count }; });
这个路由获取 URL 中的 ID 并从 MongoDB 中删除相应的待办事项。我们通过返回一个带有删除计数的简单对象来响应请求。
现在,我们可以使用以下命令发送 DELETE 请求来删除刚才创建的待办事项:
curl -X DELETE http://localhost:8000/todos/6078a83cb9f9b50008ddd109
应该会收到以下响应:
{"count":1}
更新待办事项
我们还可以添加一个 PUT 路由来更新待办事项。在 main.js 中添加以下代码:
-- -------------------- ---- ------- ------------------------ ----- ----- -- - ----- -- - -------------- ----- - ----- - - ----- ------------------- ----- ----- - ----- ---------------- - ---- - ----- -- - -- - ----- - ----- ---------- - -- -- ----------------- - - ----- -- ---
这个路由获取 URL 中的 ID 并从请求正文中获取新的待办事项文本。然后,它通过在 MongoDB 中使用 $set 操作符来更新文档。我们通过返回一个带有更新计数的简单对象来响应请求。
现在,我们可以使用以下命令发送 PUT 请求来更新待办事项:
curl -X PUT -d '{"text":"Buy juice"}' http://localhost:8000/todos/6078a83cb9f9b50008ddd109
应该会收到以下响应:
{"count":1}
错误处理
最后,我们需要添加一些错误处理。在 main.js 中添加以下代码:
app.use(async (ctx, next) => { try { await next(); } catch (err) { ctx.response.body = { error: err.message }; ctx.response.status = err.status || 500; } });
这个中间件会捕捉所有抛出的错误,并将它们转换为 JSON 格式的响应。如果错误具有 status 属性,则它将用作响应状态码。否则,它将默认为 500(服务器错误)。
总结
使用 Deno 可以轻松构建 REST API。在本文中,我们介绍了如何使用 oak 和 mongo 驱动程序来创建一个带有 CRUD 路由的待办事项列表应用程序。我们还添加了错误处理中间件,以处理可能出现的异常情况。
使用 Deno 可以实现更高效、更安全、更易于维护的 Web 开发,建议你深入学习并应用在实践中。完整的源代码可以在 GitHub 上找到。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6457606a968c7c53b0a1a87e