Swagger Codegen 简介

1. 前言

大家好，今天为大家介绍Swagger Codegen。Swagger Codegen 相信各位在中大型项目中都使用过，他的功能点和一些自带的特性可以支持绝大数项目的构建，话不多说，咱们直入正题。

2. 什么是 Swagger Codegen ？

什么是 Swagger Codegen 呢？在 Swagger 官网中是这么介绍的：

Swagger Codegen 可以通过为任何 API 生成服务端代码和客户端代码的方式来简化 OpenAPI 的构建过程，因此，项目开发团队可以更好地关注 API 的实现和应用。 —官网

这里提到的 OpenAPI 其实就是我们所谓的 RESTFUL API 规范，关于 RESTFUL API 规范我们已经在 Swagger 简介这一小节中做了详细的介绍，有不清楚的同学可以到该小节了解，这里不再赘述。

通过上面的介绍，说白了，Swagger Codegen 就是一款可以为我们构建服务端代码和客户端代码的工具，也可以把他理解为是一种代码生成框架，而且 Swagger Codegen 用的最多的地方也就是生成服务端和客户端代码。

3. 为什么要使用 Swagger Codegen ？

那么我们为什么要使用 Swagger Codegen 呢？

3.1 完善的代码生成器

对于小型项目而言，可能不会用到 Swagger Codegen ，而对于中型及以上规模的项目而言则是很有必要使用的。

我们可以想象这样一种场景：当我们的项目需求确定之后，需要步入到开发阶段时，我们首先做的就是对项目整体进行架构，即我们用什么语言，用什么框架来开发、完成这个项目，这就需要我们首先完成一些架构中的基础设施。

基础设施就是指我们所设计的项目目录、最基本的项目实体类、项目接口类、项目服务类，往往开发这些’基础设施’会耗费我们大量的时间。

所以，当我们在项目中使用了 Swagger Codegen 之后，我们只需要进行一定的配置，运行项目，即可生成我们项目中所需的这些基础设施，这在项目前期为我们节省了大量的时间，使得我们可以把时间用在集中处理项目业务上，提升我们的开发效率。

3.2 灵活的规则配置

在我们使用 Swagger Codegen 进行代码生成操作时，我们需要对生成的代码进行统一的规定，在规定完之后，Swagger Codegen 即可为我们生成符合我们要求的代码，而且每一个类都是符合规范的。

这就表明，我们可以在代码生成前灵活的对代码生成规则进行配置，这就使得在最终生成的代码中，我们不用再为代码规范所发愁，不用专门的去修改项目中不符合规范的代码了。

4. 学习基础

1. 学习 Swagger Codegen 这个工具需要大家真实开发过项目，并且使用的是 Java 7 或以上的 JDK 版本。

2. 如果你使用过前后端分离的模式构建项目，那么你在学习 Swagger Codegen 时相信会学的很快。

5. 小结

Swagger Codegen 其实就是一款可以为项目生成’基础设施’的代码生成器，包括服务端代码和客户端代码，其强大的生成器和灵活的规则配置可以大大提升在项目前期的编码效率以及项目整体代码的规则约束力，这也是 Swagger Codegen 的核心魅力。