在现代 Web 开发中，RESTful API 已经成为了一个非常流行的交互方式。NestJS 是一款基于 Node.js 的框架，它提供了一套完整的工具链，用于构建高效且可扩展的服务器端应用程序。在本文中，我们将介绍如何使用 NestJS 来构建一个 RESTful API，并提供相应的示例代码。
什么是 RESTful API
RESTful API 是一种 Web API 的设计风格，它是一组通过 HTTP 协议来访问和操作资源的接口。资源可以是任何东西，比如数据、图像、视频、音频等。RESTful API 的最大特点就是它的无状态性，即每个请求都是独立的，不依赖于之前任何请求的状态。
RESTful API 的设计遵循一些既定的原则，比如使用一些特定的 HTTP 动词（GET、POST、PUT、DELETE）来操作资源，使用 URI 来标识资源以及使用数据格式（比如 JSON 或 XML）进行数据的传输。这些原则使得 RESTful API 的设计非常简单、灵活和易于使用。
NestJS 是一款基于 Node.js 的框架，它提供了一套完整的工具链，用于构建高效且可扩展的服务器端应用程序。NestJS 支持使用 TypeScript 和 JavaScript 进行开发，并提供了丰富的功能和插件，如路由、中间件、管道等。
安装 NestJS
首先，我们需要安装 NestJS，可以通过以下命令进行安装：
- --- - -- -----------
创建 NestJS 项目
安装完 NestJS 后，我们可以使用命令行工具（CLI）来创建一个新的 NestJS 项目：
- ---- --- ---------------
以上命令将创建一个名为“my-nest-project”的新项目，其中包含一些默认文件和文件夹（如 src、test 等）。
创建控制器
下一步，我们需要创建一个控制器（Controller），用于处理 HTTP 请求并返回相应的数据。在 NestJS 中，控制器可以通过装饰器（Decorator）进行声明。我们可以使用如下命令来创建一个名为“cats”的控制器：
- ---- - ---------- ----
以上命令将在 src 目录下创建一个新的“cats”控制器，它包含一个默认的处理函数（handler），用于处理 GET 请求。我们可以在此基础上来编写我们的 RESTful API。
下面是一个简单的“cats”控制器例子：
------ - ----------- ---- ----- ----- ----- - ---- -----------------
------ - ----------- - ---- -----------------
------ - ------------ - ---- -----------------------
-------------------
------ ----- -------------- -
------------------- -------- ------------ ------------ --
-------
----- -------------- ------------- ------------- -
------ --------------------------------------
-
------
----- --------- -
------ ---------------------------
-
-----------
----- -------------------- --- ------- -
------ -----------------------------
-
-可以看到，上述代码中我们使用了 @Controller 装饰器来声明了一个“cats”控制器。该控制器包含三个路由：
POST /cats：用于创建新的猫咪数据；GET /cats：用于获取所有猫咪数据；GET /cats/:id：用于获取指定 ID 的猫咪数据。
创建服务
下一步，我们需要创建一个服务（Service），用于处理业务逻辑。在 NestJS 中，服务与控制器紧密结合，在控制器中的路由操作中调用服务中的函数进行数据操作或者业务处理，服务通常通过装饰器进行声明。
我们可以使用如下命令来创建一个名为“cats”的服务：
- ---- - ------- ----
以上命令将在 src 目录下创建一个新的“cats”服务，它包含一些默认的函数（function），用于操作猫咪数据。
下面是一个简单的“cats”服务例子：
------ - ---------- - ---- -----------------
------ - --- - ---- -----------------------------
------ - ------------ - ---- -----------------------
-------------
------ ----- ----------- -
------- ----- ----- - ---
----- -------------------- ------------- -
----- ---- --- - -
--- ----------------------------------------
----------------
--
--------------------
------ ----
-
----- --------- -
------ ----------
-
----- ----------- ------- -
------ ------------------ -- ------ --- ----
-
-在上述例子中，我们创建了一个名为“cats”的服务，它使用了 @Injectable 装饰器进行声明。该服务包含了三个函数：
create：用于创建新的猫咪数据；findAll：用于获取所有猫咪数据；findOne：用于获取指定 ID 的猫咪数据。
连接控制器和服务
在 NestJS 中，控制器（Controller）和服务（Service）之间需要通过依赖注入来连接起来。我们可以使用如下代码将“cats”控制器和“cats”服务连接起来：
------ - ------ - ---- ----------------- ------ - -------------- - ---- -------------------- ------ - ----------- - ---- ----------------- --------- ------------ ----------------- ---------- -------------- -- ------ ----- ---------- --
在上述代码中，我们创建了一个名为“CatsModule”的模块（Module），该模块包含了“cats”控制器和“cats”服务，并使用 @Module 装饰器进行声明。
注册模块
在 NestJS 中，我们需要手动将我们创建的模块注册到应用程序中。我们可以在主函数（Main Function）中使用如下代码来注册我们的“CatsModule”模块：
------ - ----------- - ---- --------------- ------ - --------- - ---- --------------- ----- -------- ----------- - ----- --- - ----- ------------------------------ ----- ----------------- - ------------
测试 RESTful API
现在我们已经完成了一个简单的 RESTful API，我们可以使用 Postman 或其他 API 测试工具来测试我们的 API 是否能够正常工作。以下是一些常用的 API 测试工具：
- Postman：一款非常流行的 API 测试工具，提供了丰富的功能和插件；
- Insomnia：一款类似 Postman 的 API 测试工具，开源且易于使用；
- cURL：一款命令行工具，可以通过命令行来测试 Web API。
我们可以使用如下命令来启动我们的 NestJS 服务：
- --- -----
然后再使用测试工具来测试我们的 RESTful API 是否正常工作。
总结
在本文中，我们介绍了如何使用 NestJS 来构建 RESTful API。我们首先介绍了 RESTful API 的基本概念和原则，然后详细讲解了如何使用 NestJS 来创建控制器和服务，最后将它们连接起来，并注册到应用程序中。通过这些步骤，我们成功地创建了一个简单的 RESTful API，并提供了相应的示例代码，希望对大家有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/664a5012d3423812e49405dd