什么是 swagger-converter？
swagger-converter 是一个可以将 OpenAPI 规范转换成 Swagger 规范或反之的 npm 包。OpenAPI规范是用于定义 REST API 的标准格式，而 Swagger 规范是用于描述 REST API 界面的可视化格式。
swagger-converter 可以减少开发人员在编写文档上的工作负担，提高团队工作效率。
安装
安装 npm 包：
--- ------- -- -----------------
使用
命令行使用
在终端键入以下命令即可将 OpenAPI 规范转换成 Swagger 规范：
----------------- -- --------------- -- ---------------- -- -----------
-i参数后跟要转换的 OpenAPI 规范文件路径-o参数后跟转换结果要保存的文件路径-c参数后跟转换要使用的规范版本，这里我们选择 Swagger 2.0
代码使用
通过 npm 安装 swagger-converter：
--- ------- ----------------- ------
引入 swagger-converter：
----- --------- - -----------------------------
使用 converter.convertObjToYaml() 将 OpenAPI 规范对象转换成 Swagger 规范的 YAML 格式：
----- ----------- - -
-- ------- ----
--
--------------------------------------- - ---------- ------------- -- ----- ------- -- -
-- ----- -
-------------------
-------
-
--------------------
---使用 converter.convertYamlToJson() 将 Swagger YAML 规范转换成 JSON 格式：
----- -- - --------------
----- ----------- - --------------------------------------- --------
---------------------------------------- ----- ------- -- -
-- ----- -
-------------------
-------
-
--------------------
---示例代码
以下是一个使用 swagger-converter 的示例代码：
----- --------- - -----------------------------
----- -- - --------------
-- - ------- ----- ------- --
----- ----------- - --------------------------------------- --------
---------------------------------------- - ---------- ------------- -- ----- ------------ -- -
-- ----- -
-------------------
-------
-
----- ----------- - ----------------------------------------
---------------------------------------- ------------ - --------- ------ ---
---
-- - ------- ----- ------- --
----- ----------- - --------------------------------------- --------
---------------------------------------- - ---------- ------------- -- ----- ------------ -- -
-- ----- -
-------------------
-------
-
----- ----------- - ----------------------------------------
---------------------------------------- ------------ - --------- ------ ---
---总结
通过使用 swagger-converter，开发人员可以方便地将 OpenAPI 规范转换成 Swagger 规范，或将 Swagger 规范转换成 OpenAPI 规范。这可以大大减轻文档编写的工作负担，提高开发团队的效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5f6b2f63a9b7065299ccb8c0