在前后端分离的项目中，不同的团队或者不同的人负责前后端代码的编写，因此需要进行接口文档的定义与交流。常见的方案是使用 Swagger 等 API 规范工具，但是在实际开发中，可能会出现前后端人员对于 API 规范不太了解的情况。api-schema-conv 就是一个 npm 包，用于将 Swagger 规范定义的接口文档转换成易于理解的格式，并提供代码生成功能，方便开发人员进行开发。
安装及使用
首先需要全局安装 api-schema-conv：
npm i -g api-schema-conv
接着，可以使用以下命令将 Swagger 规范的接口文档转换成易于理解的形式：
api-schema-conv convert -i ./swagger.yaml -o ./api-schema.json
其中，./swagger.yaml 为 Swagger 规范定义的接口文档路径，./api-schema.json 为转换后的易于理解的接口文档路径。
接口文档转换完成后，我们可以使用以下命令生成对应的代码：
api-schema-conv generate -i ./api-schema.json -l javascript,typescript -o ./output
其中，./api-schema.json 为转换后的易于理解的接口文档路径，javascript,typescript 为生成的代码语言，./output 为生成的代码输出路径。
示例代码
下面是一个使用 api-schema-conv 生成 TypeScript 代码的示例：
-- -------------------- ---- -------
------ --------- ----------------- -
--- -------
-
------ --------- ---- -
--- -------
----- -------
---- -------
-
------ --------- ------------------- -
----- -----
-
------ ----- -------- ------------
-------- -------
------- ------------------
-- ---------------------------- -
----- --- - --------------------------------
----- -------- - ----- -----------
----- ---- - ----- ----------------
------ -
----- -----
--
-在示例代码中，我们定义了一个 getUserById 方法，用于查询用户信息。该方法接受两个参数：baseUrl 和 params，其中，baseUrl 为查询用户信息的基础路径，params 包含了查询用户信息所需的参数。
总结
api-schema-conv 是一个非常实用的 npm 包，能够将 Swagger 规范定义的接口文档转换成易于理解的格式，并提供代码生成功能。通过使用 api-schema-conv，可以方便地进行前后端接口的开发和交流。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/157351