本教程介绍了如何在 NestJS 中使用 npm 包 nest-client-generator 生成客户端代码，以便与后台 API 交互。以下是本文将要介绍的内容：
- nest-client-generator 的介绍
- 安装和使用步骤
- 示例代码及解释
nest-client-generator 介绍
nest-client-generator 是一个用于生成客户端代码的 npm 包，它支持多种语言，包括 TypeScript、JavaScript、Java、Swift 等。它基于 OpenAPI 规范（又称 Swagger 规范）生成客户端代码，可以根据 API 的定义生成对应的请求方法和数据结构，大大简化了开发人员与后台 API 的交互。
安装和使用步骤
- 安装 nest-client-generator
npm install -g nest-client-generator
- 生成客户端代码
下面以 TypeScript 为例，假设你已经有一个符合 OpenAPI 规范的文档，并保存为 swagger.json，则可以使用以下命令生成客户端代码：
nest-client-generator -l typescript -i path/to/swagger.json -o path/to/output/folder
其中，-l 参数指定生成的代码语言，-i 参数指定 OpenAPI 文档的路径，-o 参数指定生成的客户端代码输出路径。
- 使用生成的客户端代码
假设生成的客户端代码在 src/client 文件夹下，包含了 api.ts 和 model.ts 两个文件。那么在 NestJS 中使用的步骤如下：
- 在 NestJS 中的
main.ts文件中引入HttpModule：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------
---------
-------- -
----------- -- -- ----------
--
------------ ---------------- -- -- ------------- -------
--
------ ----- --------- --- 在需要调用 API 的地方，引入生成的
api.ts：
-- -------------------- ---- -------
------ - ---------- - ---- -----------------
------ - ------------- - ---- --------
------ - --- - ---- --------------- -- ----- ------
-------------
------ ----- ---------- -
------------------- -------- ------------ ------------ --
----- ----------- ---------------------- -
----- --- - --- ---------------------- -- -- --- --
------ --------------- -- -------
-
-以上代码中，我们使用 NestJS 自带的 HttpService，并在构造函数中传递给生成的 Api 对象，以便调用其生成的请求方法。
示例代码及解释
假设我们的 API 文档定义了 GET /book 接口，用于获取书籍列表。那么使用上面的方法生成的代码中，api.ts 文件可能会包含以下内容：
-- -------------------- ---- -------
------ - ----------- - ---- -----------------
------ - ------------ - ---- --------
------ - ---- - ---- ----------
------ ----- --- -
------------------- ------------ ------------ --
----------- -------------------- -
----- --- - --------
------ --------------------------
-
-以上代码中，Api 类接收一个 HttpService，用于发送 HTTP 请求。getBooks() 方法是根据 OpenAPI 文档自动生成的代码，用于向 /book 接口发送 GET 请求，并将结果解析为 Book[] 数组。使用时，只需要在调用处创建一个 Api 对象，并调用 getBooks() 方法即可。
async getBooks(): Promise<AxiosResponse> {
const api = new Api(this.httpService);
return api.getBooks();
}然后你就可以在控制器等地方调用 getBooks() 方法，并使用 Axios 提供的方法获取数据了。
以上就是本文对于 npm 包 nest-client-generator 的使用教程，希望对你在 NestJS 项目中集成 OpenAPI 客户端有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600673e2fb81d47349e53d94