介绍
TypeScript 是一种在 JavaScript 之上构建大型应用程序的语言。它附加了静态类型和其他面向对象的特性，从而使代码更易于理解和维护。在本文中，我们将探讨如何使用 TypeScript 框架构建 RESTful API 并进行单元测试。
环境
在开始之前，您需要一些基本的环境：
- Node.js（版本 14 或以上）
- TypeScript 转换器（当您在 Web 应用程序中使用 TypeScript 时，Web 浏览器不知道如何解析它们。这是因为浏览器只能理解 JavaScript。因此，我们需要一个转换器来将 TypeScript 转换为 JavaScript。这个转换器还将负责类型检查和其他有用的功能。）
- Express（Web 框架，用于构建 API）
配置实现
环境配置
首先，让我们来创建一个新的 Node.js 项目并安装我们需要的依赖项。
运行以下命令：
----- ---------------------- -- ---------------------- --- ---- -- --- - -- ---------- ------- ------- --- - ------- ----------- ------
这将创建一个新的目录 typescript-restful-api，初始化 Node.js 项目，安装 TypeScript、ts-node、nodemon、Express、body-parser 和 helmet。
TypeScript 配置
接下来，我们需要为 TypeScript 配置我们的项目。
创建一个名为 tsconfig.json 的新文件并添加以下代码：
-
------------------ -
--------- ------
--------- -----------
------ ------- ------ ------------------------
--------- ---------
------------ -----
--------- -----
------------------ -----
--------------- -----
----------------------------------- ----
--
---------- ---------------
---------- ---------------- -----------------
-这会告诉 TypeScript 编译器如何将项目转换为 JavaScript。此外，我们还指定了输出目录和源地图，并启用了严格模式和 esModuleInterop 选项（这使得运行与所有 TypeScript 模块兼容的 JavaScript 模块变得更加容易）。
Nodemon 配置
Nodemon 是一个监视文件更改并重新启动 Node.js 服务器的工具。在开发过程中，它非常有用。
我们需要在项目的根目录中创建 nodemon.json 文件并添加以下内容：
- -------- -------- ------ ----- --------- --------------------- ------- -------- --------------- -
这将通知 Nodemon 监视 src 目录中的所有文件。它还将忽略任何 *.spec.ts 文件。最后，当文件更改时，它将使用 ts-node 运行我们的应用程序。
编写 API
现在，我们已经完成了项目的环境和配置设置，开始编写我们的 API。
在 src 目录中，创建一个名为 index.ts 的新文件。这是我们将开始编写我们的 API 的地方。
在 index.ts 中添加以下代码：
------ -------- - ------------ -------- --------- ------------ - ---- ---------- ------ ---------- ---- -------------- ----- ---- ----------- - ---------- --------------------------- ------------------------------- --------- ---- ---- ------------ ----- -------- ---- --------- -- - ----------------- -- -- ---------- ------- ------- --- ----- ----- ------ - ----- ---------------- -- -- - ------------------- ------- -- ---- ----------- ---
此代码将创建一个名为 app 的新 Express 应用程序。为该应用程序添加了 body-parser 中间件，监听 / 路径的 GET 请求，并将端口号设置为 5000。启动服务器后，在浏览器中访问 http://localhost:5000/，您应该能够看到“Welcome to my TypeScript RESTful API!”的消息。
单元测试
现在，您已经学会了如何编写和运行 TypeScript RESTful API。让我们学习如何编写和运行单元测试。
首先，我们需要添加一些新的依赖项，以便编写和运行测试。
运行以下命令：
--- - -- ---- ------- ----------- ---------
这将安装 Jest、ts-jest、@types/jest 和 supertest。Jest 是一个流行的 JavaScript 测试框架，我们将使用它来编写我们的测试。ts-jest 是 Jest 的 TypeScript 预处理器。
现在，让我们为我们的应用程序编写测试。
在根目录下创建一个名为 test 的新目录，并在其中创建一个名为 app.spec.ts 的新文件。
在 app.spec.ts 中添加以下代码：
------ --------- ---- ------------
------ --- ---- ---------------
----- ------- - ---------------
-------------- ----------- -- -- -
-------- --- --- ---------- ----- -- -- -
----- -------- - ----- -----------------
----------------------------------
---------------------------------------- -- -- ---------- ------- -------
---
---此代码将使用 supertest 模块使我们能够轻松地发送 HTTP 请求到我们的应用程序。
此测试会检查我们的应用程序是否正常运行，并且能够返回我们的预期响应。它将向应用程序的根目录发送 GET 请求，然后检查响应状态是否为 200，以及响应是否包含我们预期的消息。
运行测试
一旦您编写好了测试用例，就可以运行测试。
在项目的根目录中运行以下命令：
--- ----
Jest 将运行您的测试，并告诉您测试是否通过。
结论
在本文中，我们已经了解了如何使用 TypeScript 框架构建 RESTful API，并进行单元测试。我们学习了环境配置、TypeScript 配置、Nodemon 配置、API 编写以及单元测试。现在，您可以使用我们的模板来开始构建您自己的 RESTful API。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/670ce6165f551281025bf830