Spring Boot整合swagger使用教程详解

 <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>

package com.example.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration // 标明是配置类
@EnableSwagger2 //开启swagger功能
public class SwaggerConfig {
 @Bean
 public Docket createRestApi() {
 return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 固定的，代表swagger2
//  .groupName("分布式任务系统") // 如果配置多个文档的时候，那么需要配置groupName来分组标识
  .apiInfo(apiInfo()) // 用于生成API信息
  .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
  .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 用于指定扫描哪个包下的接口
  .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
  .build();
 }

 /**
 * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本
 * @return
 */
 private ApiInfo apiInfo() {
 return new ApiInfoBuilder()
  .title("XX项目API") // 可以用来自定义API的主标题
  .description("XX项目SwaggerAPI管理") // 可以用来描述整体的API
  .termsOfServiceUrl("") // 用于定义服务的域名
  .version("1.0") // 可以用来定义版本。
  .build(); //
 }
}

@Api(tags = "角色管理") // tags：你可以当作是这个组的名字。
@RestController
public class RoleController {
}

@Api(tags = "用户管理") // tags：你可以当作是这个组的名字。
@RestController
public class UserController {
}

@Api(tags = "用户管理")
@RestController
public class UserController {
 // 注意，对于swagger，不要使用@RequestMapping，
 // 因为@RequestMapping支持任意请求方式，swagger会为这个接口生成7种请求方式的接口文档
 @GetMapping("/info") 
 public String info(String id){
 return "aaa";
 }
}

@ApiOperation(value = "用户测试",notes = "用户测试notes")
 @GetMapping("/test")
 public String test(String id){
 return "test";
 }

// 先使用@ApiModel来标注类
@ApiModel(value="用户登录表单对象",description="用户登录表单对象")
public class LoginForm {
 // 使用ApiModelProperty来标注字段属性。
 @ApiModelProperty(value = "用户名",required = true,example = "root")
 private String username;
 @ApiModelProperty(value = "密码",required = true,example = "123456")
 private String password;

 // 此处省略入参赋值时需要的getter,setter,swagger也需要这个
}

 @ApiOperation(value = "登录接口",notes = "登录接口的说明")
 @PostMapping("/login")
 public LoginForm login(@RequestBody LoginForm loginForm){
 return loginForm;
 }

 // 使用URL query参数
 @ApiOperation(value = "登录接口2",notes = "登录接口的说明2")
 @ApiImplicitParams({
  @ApiImplicitParam(name = "username",//参数名字
   value = "用户名",//参数的描述
   required = true,//是否必须传入
   //paramType定义参数传递类型：有path,query,body,form,header
   paramType = "query"
   )
  ,
  @ApiImplicitParam(name = "password",//参数名字
   value = "密码",//参数的描述
   required = true,//是否必须传入
   paramType = "query"
   )
 })
 @PostMapping(value = "/login2")
 public LoginForm login2(String username,String password){
 System.out.println(username+":"+password);
 LoginForm loginForm = new LoginForm();
 loginForm.setUsername(username);
 loginForm.setPassword(password);
 return loginForm;
 }

 // 使用路径参数
 @PostMapping("/login3/{id1}/{id2}")
 @ApiOperation(value = "登录接口3",notes = "登录接口的说明3")
 @ApiImplicitParams({
  @ApiImplicitParam(name = "id1",//参数名字
   value = "用户名",//参数的描述
   required = true,//是否必须传入
   //paramType定义参数传递类型：有path,query,body,form,header
   paramType = "path"
  )
  ,
  @ApiImplicitParam(name = "id2",//参数名字
   value = "密码",//参数的描述
   required = true,//是否必须传入
   paramType = "path"
  )
 })
 public String login3(@PathVariable Integer id1,@PathVariable Integer id2){
 return id1+":"+id2;
 }

 // 用header传递参数
 @PostMapping("/login4")
 @ApiOperation(value = "登录接口4",notes = "登录接口的说明4")
 @ApiImplicitParams({
  @ApiImplicitParam(name = "username",//参数名字
   value = "用户名",//参数的描述
   required = true,//是否必须传入
   //paramType定义参数传递类型：有path,query,body,form,header
   paramType = "header"
  )
  ,
  @ApiImplicitParam(name = "password",//参数名字
   value = "密码",//参数的描述
   required = true,//是否必须传入
   paramType = "header"
  )
 })
 public String login4( @RequestHeader String username,
    @RequestHeader String password){
 return username+":"+password;
 }

 // 有文件上传时要用@ApiParam，用法基本与@ApiImplicitParam一样，不过@ApiParam用在参数上
 // 或者你也可以不注解，swagger会自动生成说明
 @ApiOperation(value = "上传文件",notes = "上传文件")
 @PostMapping(value = "/upload")
 public String upload(@ApiParam(value = "图片文件", required = true)MultipartFile uploadFile){
 String originalFilename = uploadFile.getOriginalFilename();
 return originalFilename;
 }
 // 多个文件上传时，**swagger只能测试单文件上传**
 @ApiOperation(value = "上传多个文件",notes = "上传多个文件")
 @PostMapping(value = "/upload2",consumes = "multipart/*", headers = "content-type=multipart/form-data")
 public String upload2(@ApiParam(value = "图片文件", required = true,allowMultiple = true)MultipartFile[] uploadFile){
 StringBuffer sb = new StringBuffer();
 for (int i = 0; i < uploadFile.length; i++) {
  System.out.println(uploadFile[i].getOriginalFilename());
  sb.append(uploadFile[i].getOriginalFilename());
  sb.append(",");
 }
 return sb.toString();
 }
 // 既有文件，又有参数
 @ApiOperation(value = "既有文件，又有参数",notes = "既有文件，又有参数")
 @PostMapping(value = "/upload3")
 @ApiImplicitParams({
  @ApiImplicitParam(name = "name",
   value = "图片新名字",
   required = true
  )
 })
 public String upload3(@ApiParam(value = "图片文件", required = true)MultipartFile uploadFile,
    String name){
 String originalFilename = uploadFile.getOriginalFilename();
 return originalFilename+":"+name;
 }

 // 返回被@ApiModel标注的类对象
 @ApiOperation(value = "实体类响应",notes = "返回数据为实体类的接口")
 @PostMapping("/role1")
 public LoginForm role1(@RequestBody LoginForm loginForm){
 return loginForm;
 }

 // 其他类型的,此时不能增加字段注释，所以其实swagger推荐使用实体类
 @ApiOperation(value = "非实体类",notes = "非实体类")
 @ApiResponses({
  @ApiResponse(code=200,message = "调用成功"),
  @ApiResponse(code=401,message = "无权限" )
 }
 )
 @PostMapping("/role2")
 public String role2(){
 return " {\n" +
  " name:\"广东\",\n" +
  " citys:{\n" +
  "  city:[\"广州\",\"深圳\",\"珠海\"]\n" +
  " }\n" +
  " }";
 }

 <!--引入swagger-->
 <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>
 <!-- 引入swagger-bootstrap-ui依赖包-->
 <dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>swagger-bootstrap-ui</artifactId>
  <version>1.8.7</version>
 </dependency>

@Configuration // 标明是配置类
@EnableSwagger2 //开启swagger功能
@EnableSwaggerBootstrapUI // 开启SwaggerBootstrapUI
public class SwaggerConfig {
 // 省略配置内容
}

.antMatchers("/swagger**/**").permitAll()
.antMatchers("/webjars/**").permitAll()
.antMatchers("/v2/**").permitAll()
.antMatchers("/doc.html").permitAll() // 如果你用了bootstarp的Swagger UI界面，加一个这个。

//如果有额外的全局参数，比如说请求头参数，可以这样添加
 ParameterBuilder parameterBuilder = new ParameterBuilder();
 List<Parameter> parameters = new ArrayList<Parameter>();
 parameterBuilder.name("authorization").description("令牌")
  .modelRef(new ModelRef("string")).parameterType("header").required(false).build();
 parameters.add(parameterBuilder.build());
 return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 固定的，代表swagger2
  .apiInfo(apiInfo()) // 用于生成API信息
  .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
  .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 用于指定扫描哪个包下的接口
  .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
  .build().globalOperationParameters(parameters);

 // 如果需要额外的参数，非本方法用到，但过滤器要用,类似于权限token
 @PostMapping("/login6")
 @ApiOperation(value = "带token的接口",notes = "带token的接口")
 @ApiImplicitParams({
  @ApiImplicitParam(name = "authorization",//参数名字
   value = "授权token",//参数的描述
   required = true,//是否必须传入
   paramType = "header"
  )
  ,
  @ApiImplicitParam(name = "username",//参数名字
   value = "用户名",//参数的描述
   required = true,//是否必须传入
   paramType = "query"
  )
 })
 public String login6(String username){
 return username;
 }