跳到主要内容

Swagger Codengen 主流环境安装

1. 前言

本节会为大家介绍如何在当下主流操作系统中安装 Swagger Codegen 代码生成器。

重点讲解内容:

  • 如何在 Windows 系统中安装 Swagger Codegen ;
  • 如何在 OS X 系统 (Mac) 中安装 Swagger Codegen ;
  • Swagger Codegen 安装是否成功的必要性测试。

2. 如何在 Windows 系统中安装 Swagger Codegen ?

针对 Windows 环境,Swagger Codegen 官方并没有直接提供很好的安装方法,所以这里我们采用另一种方式,这也是我总结出来的方法,屡试不爽。

2.1 第一步:获取 Swagger Codegen Jar 包

我们进入 Swagger Codegen 的开源界面,会得到官网所推荐的下载 jar 包的链接,链接比较长,这里我已经下好了,同学们可以直接从我的 Git 上进行下载:

https://github.com/SteafanMrZhou/MoocSwaggerWiki

2.2 第二步:在 Windows 环境 安装 Swagger Codegen

我们在拿到 Swagger Codegen 的 jar 包后,可以使用 Java 提供的命令来解析该 jar 包:

java -jar swagger-codegen-cli.jar help

运行以上命令之后,我们会得到很多关于 Swagger Codegen 的帮助信息,如下图所示:

由于我使用的是 Mac 系统,所以我在我的 Mac 上安装了 Win 的虚拟机来为大家演示。

3. 如何在 OS X 系统 (Mac) 中安装 Swagger Codegen

在 OS X 系统中安装 Swagger Codegen 和在 Windows 中安装 Swagger Codegen 大同小异,只是说我们所依赖的平台和安装的方式不同而已,接下来让我们来看看如何在 OS X 系统中安装 Swagger Codegen 吧。

3.1 第一步 确认 Mac 中是否已经安装 Homebrew

众所周知,如果你是使用 Mac 来工作的,那么你一定听说过 Hoembrew 了,Hoembrew 就类似于我们使用的 Maven ,但是不同于 Maven 的是,他即可以管理项目中的依赖包,也可以管理我们电脑中的依赖包,例如:Java 。

如何确认电脑中是否已经安装了 Homebrew 呢 ? 我们可以在 Mac 的终端中使用以下命令确认:

brew

直接在终端中输入上述命令,然后按回车,如果会提示以下信息,说明 Homebrew 已经安装:

3.2 第二步 使用 Homebrew 安装 Swagger-Codegen

当我们的 Mac 中已经安装了 Hoembrew ,那么我们可以通过以下命令来安装 Swagger-Codegen :

brew install swagger-codegen

如上图所示,如果你的 Homebrew 已经很长时间没使用了,那么他会自动更新 Homebrew 中已安装的依赖包,这需要等待一段时间。

在更新完 Homebrew 之后,我们可以等待 Swagger-Codegen 的安装完成,如下图所示:

可以看到,当我们输入 help 命令时并不会提示我们像 Windows 环境中的信息,这是因为在 Mac 环境中 Swagger-Codegen 所使用的命令格式和 Windows 中的不一样导致,这里就不再详细介绍了。

4. Swagger Codegen 安装是否成功的必要性测试及注意事项

4.1 Windows 环境

当我们运行 jar 包之后出现上述截图中所显示的帮助信息,说明我们下载的 jar 包是正确的,并且也说明 Swagger-Codegen 在我们的电脑中已经安装成功了,接下来就可以使用 Swagger-Codegen 为我们提供的命令来使用 Swagger Codegen 了。

4.2 OS X (Mac) 环境

和 Windows 环境一样,如果在 Homebrew 中安装 Swagger-Codegen 结束之后,给我们在终端打印出了 Swagger-Codegen 的帮助提示信息,那就说明我们在 Mac 中使用 Homebrew 安装 Swagger-Codegen 是成功的。

Tips :

  1. 我们在安装 Swagger-Codegen 的时候,无论是 Windows 平台还是 OS X 平台,首先都需要将 Swagger-Codegen 的 jar 包下载下来,然后我们再针对平台分而治之,但是请记住,无论在哪个平台安装 Swagger-Codegen ,都要确保电脑上是 Java 7 以及更高的版本才行。
  2. 一般在使用 Swagger-Codegen 的时候,绝大多数情况使用的都是 Swagger-Codegen 的最新稳定版本,所以各位在安装 Swagger-Codegen 时,务必要和本小节中使用的版本 (2.4.14) 保持一致,以免发生不必要的问题。

5. 小结

本小节针对当下主流操作系统,分别详细介绍了在 Windows 平台和 OS X (Mac) 平台安装 Swagger-Codegen 的步骤,以及在安装时候容易出现的问题,针对 Swagger-Codegen 的 Jar 包,考虑到自行下载可能下不动的情况,所以又额外提供了相关资源连接,同学们可以直接下载。