Swagger Codegen 簡介

1. 前言

大家好，今天為大家介紹Swagger Codegen。Swagger Codegen 相信各位在中大型項(xiàng)目中都使用過，他的功能點(diǎn)和一些自帶的特性可以支持絕大數(shù)項(xiàng)目的構(gòu)建，話不多說，咱們直入正題。

2. 什么是 Swagger Codegen ？

什么是 Swagger Codegen 呢？在 Swagger 官網(wǎng)中是這么介紹的：

Swagger Codegen 可以通過為任何 API 生成服務(wù)端代碼和客戶端代碼的方式來簡化 OpenAPI 的構(gòu)建過程，因此，項(xiàng)目開發(fā)團(tuán)隊(duì)可以更好地關(guān)注 API 的實(shí)現(xiàn)和應(yīng)用。 —官網(wǎng)

這里提到的 OpenAPI 其實(shí)就是我們所謂的 RESTFUL API 規(guī)范，關(guān)于 RESTFUL API 規(guī)范我們已經(jīng)在 Swagger 簡介這一小節(jié)中做了詳細(xì)的介紹，有不清楚的同學(xué)可以到該小節(jié)了解，這里不再贅述。

通過上面的介紹，說白了，Swagger Codegen 就是一款可以為我們構(gòu)建服務(wù)端代碼和客戶端代碼的工具，也可以把他理解為是一種代碼生成框架，而且 Swagger Codegen 用的最多的地方也就是生成服務(wù)端和客戶端代碼。

3. 為什么要使用 Swagger Codegen ？

那么我們?yōu)槭裁匆褂?Swagger Codegen 呢？

3.1 完善的代碼生成器

對于小型項(xiàng)目而言，可能不會用到 Swagger Codegen ，而對于中型及以上規(guī)模的項(xiàng)目而言則是很有必要使用的。

我們可以想象這樣一種場景：當(dāng)我們的項(xiàng)目需求確定之后，需要步入到開發(fā)階段時，我們首先做的就是對項(xiàng)目整體進(jìn)行架構(gòu)，即我們用什么語言，用什么框架來開發(fā)、完成這個項(xiàng)目，這就需要我們首先完成一些架構(gòu)中的基礎(chǔ)設(shè)施。

基礎(chǔ)設(shè)施就是指我們所設(shè)計(jì)的項(xiàng)目目錄、最基本的項(xiàng)目實(shí)體類、項(xiàng)目接口類、項(xiàng)目服務(wù)類，往往開發(fā)這些’基礎(chǔ)設(shè)施’會耗費(fèi)我們大量的時間。

所以，當(dāng)我們在項(xiàng)目中使用了 Swagger Codegen 之后，我們只需要進(jìn)行一定的配置，運(yùn)行項(xiàng)目，即可生成我們項(xiàng)目中所需的這些基礎(chǔ)設(shè)施，這在項(xiàng)目前期為我們節(jié)省了大量的時間，使得我們可以把時間用在集中處理項(xiàng)目業(yè)務(wù)上，提升我們的開發(fā)效率。

3.2 靈活的規(guī)則配置

在我們使用 Swagger Codegen 進(jìn)行代碼生成操作時，我們需要對生成的代碼進(jìn)行統(tǒng)一的規(guī)定，在規(guī)定完之后，Swagger Codegen 即可為我們生成符合我們要求的代碼，而且每一個類都是符合規(guī)范的。

這就表明，我們可以在代碼生成前靈活的對代碼生成規(guī)則進(jìn)行配置，這就使得在最終生成的代碼中，我們不用再為代碼規(guī)范所發(fā)愁，不用專門的去修改項(xiàng)目中不符合規(guī)范的代碼了。

4. 學(xué)習(xí)基礎(chǔ)

1. 學(xué)習(xí) Swagger Codegen 這個工具需要大家真實(shí)開發(fā)過項(xiàng)目，并且使用的是 Java 7 或以上的 JDK 版本。

2. 如果你使用過前后端分離的模式構(gòu)建項(xiàng)目，那么你在學(xué)習(xí) Swagger Codegen 時相信會學(xué)的很快。

5. 小結(jié)

Swagger Codegen 其實(shí)就是一款可以為項(xiàng)目生成’基礎(chǔ)設(shè)施’的代碼生成器，包括服務(wù)端代碼和客戶端代碼，其強(qiáng)大的生成器和靈活的規(guī)則配置可以大大提升在項(xiàng)目前期的編碼效率以及項(xiàng)目整體代碼的規(guī)則約束力，這也是 Swagger Codegen 的核心魅力。