SpringBoot2+ Swagger3 使用教程

1.pom文件中引入Swagger3依赖

<dependency>
     <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
      <version>3.0.0</version>
</dependency>

2.编写Swagger3Config配置类

package com.infoshare.config;

import io.swagger.annotations.ApiOperation;
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

//@EnableSwagger2 是 swagger2.0版本的注解
//swagger在3.0之后换成了@EnableOpenApi
@Configuration
@EnableOpenApi
public class Swagger3Config {

@Bean
public Docket createRestApi(){
    return new Docket(DocumentationType.OAS_30)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//如果没有参考SWAGGER2
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
            .title("Swagger3接口文档")
            .description("适用于前后端分离统一的接口文档")
            .version("1.0")
            .build();
}

}

3.Swagger3.0常用注解

@Api：用在请求的类上，表示对类的说明
  tags=“说明该类的作用，可以在UI界面上看到的注解”
  value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”


@ApiOperation：用在请求的方法上，说明方法的用途、作用
  value=“说明方法的用途、作用”
  notes=“方法的备注说明”


@ApiImplicitParams：用在请求的方法上，表示一组参数说明
  @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    name：参数名
    value：参数的汉字说明、解释
    required：参数是否必须传
    paramType：参数放在哪个地方
    · header --> 请求参数的获取：@RequestHeader
    · query --> 请求参数的获取：@RequestParam
    · path（用于restful接口）–> 请求参数的获取：@PathVariable
     · div（不常用）
    · form（不常用）
    dataType：参数类型，默认String，其它值dataType=“Integer”
    defaultValue：参数的默认值


@ApiResponses：用在请求的方法上，表示一组响应
  @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如"请求参数没填好"
    response：抛出异常的类


@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）


@ApiModelProperty：用在属性上，描述响应类的属性

4.Controller 层使用Swagger3注解例子

package com.infoshare.controller;

import com.infoshare.service.IUserService;
import com.infoshare.util.SendMailUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.scheduling.annotation.Async;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;


/**

 * @author: RJC

 * @time: 2020/9/12
   */
   @Api(tags = "用户信息处理")
   @RestController
   @RequestMapping("/user")
  public class UserController {

   @Resource(name = "userServiceImpl")
   private IUserService userService;

   @Resource(name = "sendMailUtil")
   private SendMailUtil sendMailUtil;

   private final static int AUTH_CODE_VALID_TIME = 600; //验证码失效时间为 10 min

   /**

    * 异步获得验证码的接口
    * 验证码存储到 Session 里面
    * @param mail 邮箱
    * @return authCode_
      */
      @ApiOperation("用户获得注册验证码")
      @Async
      @GetMapping("/getAuthCode")
      public String getAuthCode(@RequestParam(name = "mail") String mail,
                            HttpSession session){
      String authCode_ = sendMailUtil.sendMailAndGetAuthCode(mail);
      session.setAttribute("mail",authCode_);
      session.setMaxInactiveInterval(AUTH_CODE_VALID_TIME); //设置验证码失效时间为10min
      return authCode_;
      }

}

5.访问Swagger3接口文档界面
Swagger的访问路径由port/swagger-ui.html改成了 port/swagger-ui/ 或port/swagger-ui/index.html
两种访问方式任选其一

localhost:8080/swagger-ui/
localhost:8080/swagger-ui/index.html

6.Swagger3接口文档界面展示

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Mm0DsPqm-1630293229894)(F:\S4\Linux\Centos8安装文档图片\EREW.jpg)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-uSR8nfxC-1630293229897)(F:\S4\Linux\Centos8安装文档图片\twerw.jpg)]

swagger2使用

插入依赖

<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.imooc.project.config;



import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

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;



/**

 * @author hh
   */
   @Configuration
   @EnableSwagger2
   public class SwaggerConfig extends WebMvcConfigurationSupport {
   @Bean
   public Docket createRestApi() {
       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .select()
               .apis(RequestHandlerSelectors.basePackage("com.imooc.project.controller"))
               .paths(PathSelectors.any())
               .build();
   }

   private ApiInfo apiInfo() {
       return new ApiInfoBuilder()
               .title("接口总览")
               .description("测试")
               .version("1.0")
               .build();
   }

   /**

    * 防止@EnableMvc把默认的静态资源路径覆盖了，手动设置的方式
      *
    * @param registry
      */
      @Override
      protected void addResourceHandlers(ResourceHandlerRegistry registry) {
      // 解决静态资源无法访问
      registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
      // 解决swagger无法访问
      registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
      // 解决swagger的js文件无法访问
      registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

   }

}