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 的核心魅力。