SpringBoot整合Swagger2

第一步，导入swagger依赖：

   io.springfox
   springfox-swagger2
   2.9.2


   io.springfox
   springfox-swagger-ui
   2.9.2

第二步，创建一个SwaggerConfig类：

 @Configuration
 @EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
      return new Docket(DocumentationType.SWAGGER_2)
            .pathMapping("/")
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.zhangyu.coderman.web.controller"))
            .paths(PathSelectors.any())
            .build().apiInfo(new ApiInfoBuilder()
                    .title("社区圈接口文档")
                    .description("SpringBoot整合Swagger，详细信息......")
                    .version("1.0")
                    .contact(new Contact("前端页面地址","http://localhost:8081/",""))
                    .license("The Apache License")
                    .licenseUrl("http://www.baidu.com")
                    .build());
  }
}

这里的配置类通过@EnableSwagger2注解启用Swagger2，然后配置一个Docket Bean，这个Bean中，配置映射路径和要扫描的接口的位置，在apiInfo中，主要配置一下Swagger2文档网站的信息，例如网站的标题，网站的描述，联系人的信息，使用的协议等等。

第三步，通过http://localhost:8080/swagger-ui.html访问接口文档

如果显示以上页面就表示配置成功了

第四步，为接口添加描述

@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("根据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("根据id更新用户的接口")
public User updateUserById(@RequestBody User user) {
    return user;
}

}

• @Api注解可以用来标记当前Controller的功能。
• @ApiOperation注解用来标记一个方法的作用。
• @ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。
• 如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。
• 注解还可以加在实体类中：

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

重新启动后访问效果如下: