在前端开发中，我们经常需要与后端进行接口数据交互。Swagger 是一种常用的 API 规范，能够帮助我们描述接口数据的格式和请求方式。而 TypeScript 是一种强类型语言，能够帮助我们更好地管理数据类型。如果我们能够将 Swagger 规范自动生成 TypeScript 类型定义，就能大大提高开发效率和代码质量。本文介绍了一个 npm 包，即 zm-swagger-to-ts，它能够帮助我们将 Swagger 规范自动生成 TypeScript 类型定义。
安装
使用 npm 命令进行全局安装：
npm install -g zm-swagger-to-ts
使用
使用 zm-swagger-to-ts，我们需要提供 Swagger 规范的 URL 或者本地文件路径。例如，我们有如下的 Swagger 规范：
-- -------------------- ---- -------
-------- -----
-----
------ ------ ---
-------- -----
--------- ----
--------
- ----
---------
- ----------------
---------
- ----------------
------
-------
----
-------- --- - ---- -- -----
------------ ------- - ---- -- -----
----------
------
------------ - ---- -- -----
-------
----- -----
------
----- --------------------
-----
-------- ------ - ----
------------ ------- - --- ----
-----------
- ----- ----
--- ----
--------- ----
-------
----- --------------------
----------
------
------------ --- ------- ----
-------
----- --------------------
------------
-----
----- ------
---------
- --
- ----
-----------
---
----- -------
------- -----
-----
----- ------我们可以使用以下命令将其转换为 TypeScript 类型定义：
zm-swagger-to-ts http://example.com/swagger.yaml --output-dir ./typings
其中，http://example.com/swagger.yaml 是 Swagger 规范的 URL，--output-dir ./typings 表示生成的 TypeScript 类型定义文件将保存在 ./typings 目录下。
生成的 TypeScript 类型定义文件如下：
export interface User {
id: number;
name: string;
}当我们需要在代码中使用定义的类型时，只需要在代码文件中引入生成的 TypeScript 类型定义文件即可：
-- -------------------- ---- -------
------ - ---- - ---- -----------------
-------- ----------- --------------- -
------ ---------------------------- -- ------------
-
----- -------- ---------------- ------ ------------- -
----- --- - ----- ------------------- -
------- -------
-------- -
--------------- -------------------
--
----- ---------------------
---
-- -------- -
------ -----------
- ---- -
----- --- ------------- -- ------ -------
-
-可以看到，我们在代码中使用了 User 这个类型，而不需要再手动定义它的结构。
总结
使用 npm 包 zm-swagger-to-ts，我们可以将 Swagger 规范自动生成 TypeScript 类型定义，从而提高开发效率和代码质量。需要注意的是，该工具只能处理 Swagger 2.0 规范，而且在处理复杂规范时可能出现一些问题。因此，在使用之前，我们需要对工具进行测试和验证，以确保生成的类型定义符合预期。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a430d092702382243c