SpringBoot整合Swagger2的示例

更新時間：2020年11月07日 08:48:54 作者：風塵醉獨行

這篇文章主要介紹了SpringBoot整合Swagger2的示例，幫助大家更好的理解和學習springboot框架，感興趣的朋友可以了解下

一、導入maven包　

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

二、添加工具類

@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .pathMapping("/")
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
        .paths(PathSelectors.any())
        .build().apiInfo(new ApiInfoBuilder()
            .title("SpringBoot整合Swagger")
            .description("SpringBoot整合Swagger，詳細信息......")
            .version("1.0")
            .build());
  }
}

三、添加注解

@RestController
@Api(tags = "用戶管理相關接口")
@RequestMapping("/user")
public class UserController {

  @PostMapping("/")
  @ApiOperation("添加用戶的接口")
  @ApiImplicitParams({
      @ApiImplicitParam(name = "username", value = "用戶名", defaultValue = "李四"),
      @ApiImplicitParam(name = "address", value = "用戶地址", defaultValue = "深圳", required = true)
  }
  )
  public RespBean addUser(String username, @RequestParam(required = true) String address) {
    return new RespBean();
  }

  @GetMapping("/")
  @ApiOperation("根據(jù)id查詢用戶的接口")
  @ApiImplicitParam(name = "id", value = "用戶id", defaultValue = "99", required = true)
  public User getUserById(@PathVariable Integer id) {
    User user = new User();
    user.setId(id);
    return user;
  }
  @PutMapping("/{id}")
  @ApiOperation("根據(jù)id更新用戶的接口")
  public User updateUserById(@RequestBody User user) {
    return user;
  }
}

四、注解說明

@Api注解可以用來標記當前Controller的功能。
@ApiOperation注解用來標記一個方法的作用。
@ApiImplicitParam注解用來描述一個參數(shù)，可以配置參數(shù)的中文含義，也可以給參數(shù)設置默認值，這樣在接口測試的時候可以避免手動輸入。
如果有多個參數(shù)，則需要使用多個@ApiImplicitParam注解來描述，多個@ApiImplicitParam注解需要放在一個@ApiImplicitParams注解中。
@ApiImplicitParam注解中雖然可以指定參數(shù)是必填的，但是卻不能代替@RequestParam(required = true)，前者的必填只是在Swagger2框架內必填，拋棄了Swagger2，這個限制就沒用了，所以假如開發(fā)者需要指定一個參數(shù)必填，@RequestParam(required = true)注解還是不能省略。

五、如果參數(shù)是一個對象，對于參數(shù)的描述可以放在實體類中。

@ApiModel
public class User {
  @ApiModelProperty(value = "用戶id")
  private Integer id;
  @ApiModelProperty(value = "用戶名")
  private String username;
  @ApiModelProperty(value = "用戶地址")
  private String address;
  //getter/setter
}

六、效果

附：如果我們的Spring Boot項目中集成了Spring Security，那么如果不做額外配置，Swagger2文檔可能會被攔截，此時只需要在Spring Security的配置類中重寫configure方法，添加如下過濾即可：

@Override
public void configure(WebSecurity web) throws Exception {
  web.ignoring()
      .antMatchers("/swagger-ui.html")
      .antMatchers("/v2/**")
      .antMatchers("/swagger-resources/**");
}

以上就是SpringBoot整合Swagger2的示例的詳細內容，更多關于SpringBoot整合Swagger2的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: