1. Swagger 簡介
1.1 Swagger 是什么?
Swagger 是一款 RESTful 風格的接口文檔在線自動生成 + 功能測試功能軟件。Swagger 是一個規范和完整的框架,用于生成、描述、調用和可視化 RESTful 風格的 Web 服務。目標是使客戶端和文件系統作為服務器以同樣的速度(同步)更新文件的方法,參數和模型緊密集成到服務器。
這個解釋簡單點來講就是說,Swagger 是一款可以根據 resutful 風格生成的接口開發文檔,API 文檔與 API 同步更新,并且支持做測試的一款中間軟件。
現在 Swagger 官網主要提供了幾種開源工具,提供相應的功能。可以通過配置甚至是修改源碼以達到你想要的效果。
Swagger Codegen:通過Codegen 可以將描述文件生成 html 格式和 wiki 形式的接口文檔,同時也能生成多種語言的服務端和客戶端的代碼。支持通過 jar 包,docker,node 等方式在本地化執行生成。也可以在后面的 Swagger Editor 中在線生成。
Swagger UI:提供了一個可視化的 UI 頁面展示描述文件。接口的調用方、測試、項目經理等都可以在該頁面中對相關接口進行查閱和做一些簡單的接口請求。該項目支持在線導入描述文件和本地部署 UI 項目。
Swagger Editor:類似于 markendown 編輯器的編輯 Swagger 描述文件的編輯器,該編輯支持實時預覽描述文件的更新效果。也提供了在線編輯器和本地部署編輯器兩種方式。
Swagger Inspector:感覺和 postman 差不多,是一個可以對接口進行測試的在線版的 postman。比在 Swagger UI 里面做接口請求,會返回更多的信息,也會保存你請求的實際請求參數等數據。
Swagger Hub:集成了上面所有項目的各個功能,你可以以項目和版本為單位,將你的描述文件上傳到Swagger Hub中。在 Swagger Hub 中可以完成上面項目的所有工作,需要注冊賬號,分免費版和收費版。
Springfox Swagger:Spring 基于 swagger 規范,可以將基于 SpringMVC 和 Spring Boot 項目的項目代碼自動生成 JSON 格式的描述文件。本身不是屬于 Swagger 官網提供的,在這里列出來做個說明,方便后面作一個使用的展開。
1.2 為什么要使用 Swagger?
相信無論是前端還是后端開發,都或多或少地被接口文檔折磨過。
前端經常抱怨后端給的接口文檔與實際情況不一致。
后端又覺得編寫及維護接口文檔會耗費不少精力,經常來不及更新。
其實無論是前端調用后端,還是后端調用后端,都期望有一個好的接口文檔。但是這個接口文檔對于程序員來說,就跟注釋一樣,經常會抱怨別人寫的代碼沒有寫注釋,然而自己寫起代碼起來,最討厭的,也是寫注釋。
所以僅僅只通過強制來規范大家是不夠的,隨著時間推移,版本迭代,接口文檔往往很容易就跟不上代碼了。
總之,在這個前后端分離的時代,前后端聯調會使得前后端開發人員無法做到即使協商,盡早解決。
發現了痛點就會去尋找更好的解決方案,所以 Swagger 接口文檔就應運而生了。解決方案用的人多了,就成了標準的規范。通過這套規范,你只需要按照它的規范去定義接口及接口相關的信息。再通過 Swagger 衍生出來的一系列項目和工具,就可以做到生成各種格式的接口文檔,生成多種語言的客戶端和服務端的代碼,以及在線接口調試頁面等等。
這樣,如果按照新的開發模式,在開發新版本或者迭代版本的時候,只需要更新 Swagger 描述文件,就可以自動生成接口文檔和客戶端服務端代碼,做到調用端代碼、服務端代碼以及接口文檔的一致性。
但即便如此,對于許多開發來說,編寫這個 yml 或 json 格式的描述文件,本身也是有一定負擔的工作,特別是在后面持續迭代開發的時候,往往會忽略更新這個描述文件,直接更改代碼。久而久之,這個描述文件也和實際項目漸行漸遠,基于該描述文件生成的接口文檔也失去了參考意義。
所以作為 Java 屆服務端的大一統框架 Spring,迅速將 Swagger 規范納入自身的標準,建立了 Spring-swagger 項目,后面改成了現在的 Springfox。通過在項目中引入 Springfox,可以掃描相關的代碼,生成該描述文件,進而生成與代碼一致的接口文檔和客戶端代碼。這種通過代碼生成接口文檔的形式,在后面需求持續迭代的項目中,顯得尤為重要和高效。
1.2.1 對于后端開發人員來說
- 不用再手寫 WiKi 接口拼大量的參數,避免手寫錯誤
- 對代碼侵入性低,采用全注解的方式,開發簡單
- 方法參數名修改、增加、減少參數都可以直接生效,不用手動維護
缺點:增加了開發成本,寫接口還得再寫一套參數配置
1.2.2 對于前端開發人員來說
- 后端只需要定義好接口,會自動生成文檔,接口功能、參數一目了然
- 聯調方便,如果出問題,直接測試接口,實時檢查參數和返回值,就可以快速定位是前端還是后端的問題
1.2.3 對于測試人員來說
- 對于某些沒有前端界面 UI 的功能,可以用它來測試接口
- 操作簡單,不用了解具體代碼就可以操作
2. Spring Boot 集成 Swagger2(Getting Started)
2.1 導入 Swagger 相關依賴
<dependencies><!-- 引入web才能打開瀏覽器--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- 引入Swagger2、SwaggerUI依賴 --><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>
</dependencies>
2.2 編寫 Controller
@RestController
public class HelloController {@RequestMapping("/hello")public String helloSwagger() {return "Hello Swagger!";}}
2.3 編寫 Swagger 配置類
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {
}
2.4 訪問接口文檔
訪問 http://localhost:8080/swagger-ui.html:
該 swagger-ui.html 界面是 Swagger 為我們提供的 UI 界面,可在引入的依賴中找到:
3. 配置 Swagger(SwaggerConfig.java)
Swagger 有自己的 Bean 實例:Docket
3.1 配置 Swagger ApiInfo 信息
只需要在 SwaggerConfig 配置類中添加包含 ApiInfo 類信息的 Docket Bean 實例,就可以配置 Swagger 信息:
這里我們點進 Docket 源碼中查看,發現大部分屬性已有默認值,僅有一個構造函數且需要傳入 DocumentationType 實例:
DocumentationType.java 是什么?點擊進入,這里有三個可供選擇的值:
同時若想自定義 Swagger Api 信息,則需要傳入 Swagger ApiInfo,如下為默認配置:
在 SwaggerConfig.java
中進行配置
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Beanpublic Docket swaggerInfo() {Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(getApiInfo());return docket;}private ApiInfo getApiInfo() {// 作者信息Contact contact = new Contact("Scorpions", "github.com/Wu-yikun", "w577159462@163.com");return new ApiInfo("Swagger2?!!!","Stay hungry","v2.0","gitee.com/Wu-Yikun",contact,"Apache 2.0","www.apache.org/licenses/LICENSE-2.0",new ArrayList<>());}}
訪問 http://localhost:8080/swagger-ui.html:
3.2 配置 Swagger 掃描接口
目前 Swagger 文檔中有兩個 Controller:
- 一個默認的
/error
:
- 還有一個是我們自己寫的
/hello
請求
由于
@RequestMapping
未指定提交方式method
:所以 Swagger 文檔中就會羅列出所有的 method 供選擇,如: GET、HEAD、POST、PUT、DELETE、OPTIONS、PATCH
3.2.1 select()、build()
配置 Swagger 掃描接口的一般流程:
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {// 配置Swagger的Docket實例@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis() // 指定掃描接口.paths() // 過濾路徑.build();}
}
Docket 中的 select()
返回 ApiSelectorBuilder 對象:
ApiSelectorBuilder 中的 build()
返回 Docket 對象,而 apis()
與 paths()
都返回 ApiSelectorBuilder 對象,可用于鏈式調用:
接下來介紹 apis()
與 paths()
的使用方法
3.2.2 apis()
public class ApiSelectorBuilder {private final Docket parent;private Predicate<RequestHandler> requestHandlerSelector = ApiSelector.DEFAULT.getRequestHandlerSelector();...public ApiSelectorBuilder apis(Predicate<RequestHandler> selector) {requestHandlerSelector = and(requestHandlerSelector, selector);return this;}...
}
觀察以上 ApiSelectorBuilder.java
源碼,得知 apis
方法可傳入以下參數:
① RequestHandlerSelectors.none()
: 全都不掃描
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(ReqeustHandlerSelectors.none()).build();}
}
② ReqeustHandlerSelectors.any()
: 掃描全部
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(ReqeustHandlerSelectors.any()).build();}
}
③ RequestHandlerSelectors.basePackage()
: 掃描指定包
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(ReqeustHandlerSelectors.any()).apis(RequestHandlerSelectors.basePackage("com.one.swagger.controller")).build();}
}
④ RequestHandlerSelectors.withMethodAnnotation()
: 掃描方法上的注解
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(ReqeustHandlerSelectors.withMethodAnnotation(GetMapping.class)).build();}
}
⑤ RequestHandlerSelectors.withClassAnnotation()
: 掃描類上的注解
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(ReqeustHandlerSelectors.withClassAnnotation(RestController.class)).build();}
}
綜合實例:
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean("docket")public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()/*** apis():指定掃描的接口* RequestHandlerSelectors:配置要掃描接口的方式* basePackage:指定要掃描的包* any:掃描全部* none:不掃描* withClassAnnotation:掃描類上的注解(參數是類上注解的class對象)* withMethodAnnotation:掃描方法上的注解(參數是方法上的注解的class對象)*/.apis(RequestHandlerSelectors.basePackage("com.zsr.controller")).build();}
}
3.2.3 paths()
paths()
與 apis()
相似,使用 PathSelectors
,這里不再贅述:
① PathSelectors.ant()
: 過濾 Spring 的 AntPathMatcher 提供的 match 方法匹配的路徑
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.ant("/hello/**")).build();}
}
過濾 /hello/**
請求:
② PathSelectors.regex()
: 過濾正則表達式指定的路徑
@Configuration
@EnableSwagger2 // 開啟Swagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.regex("^/hello")).build();}
}
過濾以 /hello
開頭的請求:
③ PathSelectors.none()
④ PathSelectors.any()
綜合實例:
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean("docket")public Docket docket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()/*** paths():過濾路徑* PathSelectors:配置過濾的路徑* any:過濾全部路徑* none:不過濾路徑* ant:過濾指定路徑:按照按照Spring的AntPathMatcher提供的match方法進行匹配* regex:過濾指定路徑:按照String的matches方法進行匹配*/.paths(PathSelectors.ant("/hello/**")).build();}
}
3.3 配置 API 文檔分組
上文有提及 Docket 對象中的 groupName
屬性,groupName
用于設置 API 文檔的分組,默認分組為 default。
可以為不同的分組配置不同的 Swagger 掃描接口!
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket docket1() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.none()).build().groupName("X"); // 設置API文檔為X組}@Beanpublic Docket docket2() {return new Docket(DocumentationType.SWAGGER_2).select().paths(PathSelectors.regex("^/swagger")).build().groupName("Y"); // 設置API文檔為Y組}@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths().build().groupName("Scorpions"); // 設置Swagger的API文檔分組}}
Scorpions 分組:
X 分組:
Y 分組:
3.4 配置是否啟動 Swagger
Docket 對象通過 enable()
方法來配置 Swagger 是否啟用。
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())// true表示啟用swagger、false表示不啟用swagger.enable(false).select().paths().build();}
}
enable(false)
使得僅當前分組不啟用 Swagger 文檔,而其他分組仍然啟用,若僅剩一個 group,則會出現如下的頁面:
?? 若只希望 Swagger 在開發環境中啟用,在生產環境中不啟用(發布的時候當然不能暴露 Swagger 文檔,不然造成外部可以隨意調用接口)
Environment
對象可作為參數由 Spring 容器自動傳入- 通過
environment.acceptsProfiles(profiles)
來判斷是否處于自己設定的環境當中 - 將 flag 傳入
enable()
方法的參數列表,如果處于自己設定的環境則開啟 Swagger 接口文檔
application-dev.yml
:
# 開發環境下默認使用該配置文件(約定俗成的名字)
server:port: 8080
application-pro.yml
:
# 生產環境
server:port: 8082
application.properties
:
# 使得dev環境的配置生效: application-dev
spring.profiles.active=dev
SwaggerConfig.java
:
@Configuration
@EnableSwagger2 // 開啟Swagger2, 訪問網址: http://localhost:8080/swagger-ui.html
public class SwaggerConfig {@Bean("docket")public Docket getSwaggerDocket(Environment environment) {// 設置啟用Scorpions分組下的Swagger文檔的環境列表Profiles profiles = Profiles.of("dev", "test", "otherEnv");boolean flag = environment.acceptsProfiles(profiles);return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(flag).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.ant("/hello/**")).build().groupName("Scorpions");}@Beanpublic Docket swaggerInfo(Environment environment) {// 僅在 dev、test 環境下啟用Z分組的Swagger接口文檔!Profiles profiles = Profiles.of("dev", "test");boolean flag = environment.acceptsProfiles(profiles);Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(getApiInfo()).enable(flag).select().apis(RequestHandlerSelectors.any()).build().groupName("Z");return docket;}
}
當前為開發環境:
4. Swagger 接口注釋&實體類注釋
4.1 實體類注釋
4.1.1 編寫實體類
@ApiModel
:為實體類添加注釋@ApiModelProperty
:為實體類屬性添加注釋
User.java
:
@ApiModel("用戶實體類") // 文檔注釋
public class User {public User() {}public User(String username, String password) {this.username = username;this.password = password;}// 屬性設置為 public, 在 Swagger 中才可視@ApiModelProperty("姓名")public String username;@ApiModelProperty("密碼")public String password;public String getUsername() {return username;}public void setUsername(String username) {this.username = username;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}
}
4.1.2 編寫實體類對應的請求方法
編寫完實體類后,我們還是無法在 Model 中看到 User 實體類信息,需在 HelloController
中新增一個返回 User 對象的請求方法:
@RestController
public class HelloController {@GetMapping("/swagger1")public User getUser() {return new User("Scorpions_", "123456");}
}
4.1.3 測試訪問
成功顯示 Model 信息:
4.2 接口注釋
@ApiOperation
:為接口添加注釋@ApiParam
:為接口參數列表添加注釋
示例1
@RestController
public class HelloController {@GetMapping("/swagger2")@ApiOperation("response返回錯誤")public User swagger2(@ApiParam("接口形參num") int num) {int i = num / 0;return new User();}
}
接口及其形參列表上標有注釋:
這里將 /swagger2
請求改成 POST 請求而不是 GET 請求:
@RestController
public class HelloController {@PostMapping("/swagger22")@ApiOperation("POST請求具備方法體, response返回錯誤")public User swagger2(@ApiParam("接口形參num") int num) {int i = num / 0;return new User();}
}
請求結果符合預期的 500 錯誤:
示例2
// POST 表單才可以請求, 而 Swagger 在測試時會提供方法體, 僅需輸入測試即可
// 注意傳入的參數User實體類中必須要有 getter() 和 setter(), 方法才能正常賦值到形參user中!
@ApiOperation("Swagger3 POST 請求")
@PostMapping("/swagger3")
public User swagger3(@ApiParam("user參數, 必須設置屬性的setter() & getter()") User user) {return user;
}
填寫完表單后會添加到方法體 body 中:
response 返回預期結果: