随着 Node.js 越来越流行，构建 RESTful API 的需求也越来越多。在这个过程中，使用 TypeScript 将是一个不错的选择。TypeScript 为 Node.js 应用程序提供了类型安全，可维护性和代码可读性，可节省大量时间，并减少奇怪的错误。
在本文中，我们将讨论使用 TypeScript 构建 Node.js RESTful API 的步骤，并提供完整的代码示例。
步骤
步骤一：创建一个项目
首先，我们要创建一个新的 Node.js 项目。我们可以使用 npm init 命令创建一个新的项目，并在 package.json 文件中指定依赖项。
npm init -y npm i express body-parser cors dotenv npm i --save-dev nodemon typescript @types/node @types/express @types/body-parser @types/cors
步骤二：创建一个服务器文件
在我们的项目中创建一个新的文件 server.ts，并添加以下代码。
-- -------------------- ---- ------- ------ ------- ---- ---------- ------ ---------- ---- -------------- ------ ---- ---- ------- ------ ------ ---- --------- ---------------- ----- --- - ---------- ----- ---- - ---------------- -- ----- --------------------------- ---------------- ---------------- -- -- - ------------------- --------- -- ---- ---------- ---
在上述代码中，我们使用 express 库创建了一个新的服务器，并使用 bodyParser 和 cors 库处理请求。我们还通过 dotenv 库加载了环境变量。最后，我们将服务器监听在默认端口 5000 上，并在控制台输出相应的提示。
步骤三：添加路由
接下来，我们需要添加一些路由，以便客户端可以通过发送 HTTP 请求来访问我们的 API。
在我们的项目中创建一个新的文件 routes.ts，并添加以下代码。
-- -------------------- ---- ------- ------ - ------ - ---- ---------- ----- ------ - --------- --------------- ----- ---- -- - ----------------- -- ---------- ------- ------- --- ------ ------- -------
在上述代码中，我们创建了一个新的路由，并为 / 路径添加了一个简单的 GET 请求处理函数。本例中，我们只是向客户端发送一个文本响应，但实际上，我们可以回复任何类型的数据，包括 JSON、XML 和 HTML 等。
我们现在必须在 server.ts 文件中导入此路由和使用它。
-- -------------------- ---- ------- ------ ------- ---- ---------- ------ ---------- ---- -------------- ------ ---- ---- ------- ------ ------ ---- --------- ------ ------ ---- ----------- ---------------- ----- --- - ---------- ----- ---- - ---------------- -- ----- --------------------------- ---------------- ---------------- ---------------- -- -- - ------------------- --------- -- ---- ---------- ---
在上述代码中，我们将创建的路由添加到应用程序中，并在 / 路径下处理传入的请求。
步骤四：编写控制器
现在我们需要添加控制器来处理各类来自客户端的具体请求，如 GET、POST、PUT、DELETE 等。
在我们的项目中创建一个新的文件 controllers.ts，并添加以下代码。
-- -------------------- ---- ------- ------ - -------- -------- - ---- ---------- ------ ----- -------- - ----- -------- ---- --------- -- - ------------- -------- -- ------ ----- ----------- - ----- -------- ---- --------- -- - ----- ------ - -------------- -------------- ------------ -- ------ ----- ---------- - ----- -------- ---- --------- -- - ---------------- ------- -- ------ ----- ---------- - ----- -------- ---- --------- -- - ----- ------ - -------------- ---------------- ---- ------------ -- ------ ----- ---------- - ----- -------- ---- --------- -- - ----- ------ - -------------- ---------------- ---- ------------ --
在上述代码中，我们定义了五个控制器函数来处理不同类型的客户端请求。在实际项目中，您可以添加所需数量的控制器，以便应用程序可以处理您需要提供的所有请求。
步骤五：更新路由
现在，我们已经定义了控制器，我们需要将它们与每个路由的请求处理程序链接在一起。
修改 routes.ts 文件，如下所示。
-- -------------------- ---- ------- ------ - ------ - ---- ---------- ------ - -- -------------- ---- ---------------- ----- ------ - --------- ---------------------- ----------------------------- --------------------------------- -------------------------- -------------------------------- ------------------------------- ----------------------------------- ------ ------- -------
在上述代码中，我们重构了 /users 路由，以使用 UserController 中定义的两个控制器 getUsers 和 createUser。同样，我们还将 /users/:id 路由挂在到了 getUserById、updateUser 和 deleteUser 控制器。
步骤六：编译并运行
现在可以使用以下命令将 TypeScript 代码编译成 JavaScript，然后使用以下命令运行项目。
npm run build && npm start
以上两个命令将在本地启动 API，客户端可以通过访问路由，以获取相关响应。
结论
在本文中，我们研究了如何使用 TypeScript 构建 Node.js RESTful API。我们首先创建了一个新的 Node.js 项目，然后添加了所需的依赖项。然后，我们创建了一个新的服务器文件和路由，以及添加了控制器，并将它们与路由链接。最后，我们使用 TypeScript 编译器将 TypeScript 代码转换为 JavaScript，并启动了服务器。
使用 TypeScript 编写 Node.js RESTful API 时，可以提高代码的可维护性，并减少出现奇怪错误的可能性。使用本指南，我们可以快速开始构建自己的 TypeScript API，激发开发者的创造力和项目进程。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/671009ee5f5512810268d7fc