Spring集成Swagger，3步自動生成API文檔

在Sping開發REST接口服務時，API文檔是不可缺少的一個重要部分。Swagger框架定義了完整的REST接口文檔規范，提供了強大的頁面測試功能，能夠調試和可視化API接口服務，并且將文檔融合到代碼中，讓維護文檔和修改代碼整合為一體，使得修改代碼邏輯的同時方便的修改文檔說明。

Spring集成Swagger只需3步配置，就能在線生成接口文檔，調試API功能。

l?代碼

Github下載：https://github.com/jextop/StarterApi/

l?SpringBoot集成Swagger

1.?在pom.xml中添加Swagger依賴

<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger-ui</artifactId>
????<version>2.7.0</version>
</dependency>
<dependency>
????<groupId>io.springfox</groupId>
????<artifactId>springfox-swagger2</artifactId>
????<version>2.7.0</version>
</dependency>

2.?添加SwaggerConfig.java，配置文檔信息和掃描包路徑

@Configuration
@EnableSwagger2
public class SwaggerConfig {
????@Bean
????public Docket docket() {
????????return new Docket(DocumentationType.SWAGGER_2)
????????????????.apiInfo(apiInfo())
????????????????.select()
????????????????.apis(RequestHandlerSelectors.basePackage("com.starter"))
????????????????.paths(PathSelectors.any())
????????????????.build();
????}

????private ApiInfo apiInfo() {
????????return new ApiInfoBuilder()
????????????????.title("SpringBoot搭建分布式Web服務腳手架")
????????????????.license("Github開源項目")
????????????????.licenseUrl("https://github.com/jextop")
????????????????.build();
????}
}

3.?（可選）代碼中引用Swagger注解，增加接口文檔。

- 不添加這些注解時，Swagger自動生成在線文檔將使用默認信息。

- 修改代碼功能邏輯時，同時維護文檔信息。

@Api(tags = {"用戶管理"})
@RestController
@RequestMapping("/")
public class SecurityController {
????@ApiOperation("用戶登錄")
????@GetMapping(value = "/login")
????public Object login(
????????????@RequestParam(required = false) String username,
????????????@ApiParam("密碼計算公式：md5(b64(username + password)") @RequestParam(required = false) String password
????) {
????????// todo
????}
}

l?啟動Spring項目，打開文檔頁面

1.?http://localhost:8011/swagger-ui.html

?

2.?展開API信息，點擊按鈕”Try it out!”，調試接口功能。