在前端开发中，经常需要调用后端接口来获取数据。而 Swagger 是一个 API 的框架，在 API 定义文件中描述了接口的细节。npm 上有一个工具叫做 Swagger Codegen，可以根据 Swagger 的 API 定义生成客户端代码。但是，Swagger Codegen 代码生成的质量不高，因此有人 fork 了 Swagger Codegen 并提供了一些改进。其中，就有一个改进版的 Swagger Codegen 工具，叫做 fork-swagger-js-codegen-dovjar。
安装
首先，你需要在你的项目中安装 fork-swagger-js-codegen-dovjar：
npm install fork-swagger-js-codegen-dovjar --save-dev
可用配置
fork-swagger-js-codegen-dovjar 支持以下的配置：
apiPackage: 生成的 API curl 类的包名。modelNameSuffix: 生成的模型后缀。默认是 "Model"。modelPackage: 生成的模型类的包名。httpUserAgent: 发送 HTTP 请求时用的 User-Agent。默认是 "Swagger-Codegen/2.4.4/javascript".additionalProperties: 附加属性。是一个键值对，可以自由添加额外的属性到生成的模型中。例如："additionalProperties": { "x-api-key": { "type": "string", "description": "API key" } }这将在生成的模型中增加一个名为
x-api-key的string属性，而且设置了一个属性description。
使用
生成命令如下：
swagger-codegen generate \ -i <path-to-spec-file> \ -l fork-swagger-js-codegen-dovjar \ -o <output-dir> \ --additional-properties <config-properties>
其中，<path-to-spec-file> 是你的 Swagger API 定义文件路径；<output-dir> 是你想要生成文件的目标目录；<config-properties> 是你要传递给 fork-swagger-js-codegen-dovjar 的配置，使用 JSON 格式。
下面是一个生成客户端代码的例子：
-- -------------------- ---- -------
--------------- -------- -
-- ------------------------------------------ -
-- ------------------------------ -
-- ------------- -
----------------------- -- -
----------------- ----------------------- -
--------------- -------------------- -
------------------ ---------------------- -
------------------------- - -
-------------- - --------- ----------- ---------------- ----- ----- - -
- -
--这个命令会生成以下的目录结构：
-- -------------------- ---- ------- -------------- --- ---- - --- -------- - --- ---- - - --- ---------- - - --- ---------- - --- ------- - --- -------------- - --- ----------- - --- ------------- - --- -------- - --- ------ - --- ------ - --- ------- --- ------------
你可以使用生成的模型类和 API 类来调用你的后端服务。
总结
fork-swagger-js-codegen-dovjar 是一个 Swagger 代码生成工具的改进版本，在生成质量上有所提升，可以更方便地使用。通过使用此工具，我们可以更快更好地开发我们的前端应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056cc581e8991b448e644d