快捷導(dǎo)航

SpringMVC和Swagger整合方法

更新時間：2017年08月08日 14:29:41 作者：pinkylam

Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。下面通過本文給大家分享SpringMVC和Swagger整合方法，感興趣的朋友一起看看吧

描述

Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。

總體目標(biāo)是使客戶端和文件系統(tǒng)作為服務(wù)器以同樣的速度來更新。文件的方法、參數(shù)和模型緊密集成到服務(wù)器端的代碼，允許 API 來始終保持同步。Swagger 讓部署管理和使用功能強大的 API 從未如此簡單。

配置

1、引入相關(guān)jar包：

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

2、創(chuàng)建java配置類

@Configuration
@EnableSwagger2
public class Swagger2 {
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
         // 文檔標(biāo)題
        .title("wish")
        // 文檔描述
        .description("https://github.com/handexing").termsOfServiceUrl("https://github.com/handexing")
        .version("v1")
        .build();
  }
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        // 指定controller存放的目錄路徑
        .apis(RequestHandlerSelectors.basePackage("com.wish.controller"))
        .paths(PathSelectors.any())
        .build();
  }
}

3、編寫接口文檔測試

@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
@ApiOperation(value = "測試swagger", httpMethod = "POST", notes = "testSawgger")
public ExecuteResult<Boolean> addUser(@ApiParam(value = "參數(shù)", required = true) Long id) {
  ExecuteResult<Boolean> result = new ExecuteResult<Boolean>();
  try {
    result.setSuccess(true);
  } catch (Exception e) {
    result.setSuccess(false);
  }
  return result;
}

說明：

@ApiOperation:用在方法之上

1、value: 表示接口名稱

2、notes: 表示接口詳細描述

3、httpMethod:表示接口請求方法類型

@ApiParam:用在方法參數(shù)上

1、required:表示參數(shù)是否必須傳

2、name:表示參數(shù)名稱

3、value:表示參數(shù)描述

測試

swagger2文檔的默認(rèn)地址是 /swagger-ui.html, 本地開發(fā)的訪問http://localhost:8080/swagger-ui.html就可以看到自動生成的文檔了