Swagger

Swagger

knife4j对swagger进行了封装，在访问在线接口文档YApi时在pom中导入knife4j的依赖即可。

Swagger可以在线查看你写的ajax请求。请求路径，请求参数等。还可以查看ajax请求后的响应数据。

swagger用法

1.导入knife4j的maven坐标（依赖）。

 <!--knife4j读取yapi接口文档-->
 <dependency>
     <groupId>com.github.xiaoymin</groupId>
     <artifactId>knife4j-spring-boot-starter</artifactId>
     <version>3.0.2</version>
 </dependency>

2.在配置类中加入knife4j的相关配置。

Config层（WebMvcConfiguration.class ）----一般放在@Configuration配置类WebMvcConfiguration.class 中。

 /**
  * 通过knife4j生成接口文档
  * @return
  */
 @Bean
 public Docket docket() {
     ApiInfo apiInfo = new ApiInfoBuilder()
             .title("项目接口文档")
             .version("2.0")
             .description("项目接口文档")
             .build();
     Docket docket = new Docket(DocumentationType.SWAGGER_2)
             .apiInfo(apiInfo)
             .select()
             .apis(RequestHandlerSelectors.basePackage("controller包的路径"))
             .paths(PathSelectors.any())
             .build();
     return docket;
 }

3.设置静态资源映射，否则接口文档页面无法访问。

Config层（WebMvcConfiguration.class ）----一般放在@Configuration配置类WebMvcConfiguration.class 中。

 /**
  * 设置静态资源映射
  * @param registry
  */
 protected void addResourceHandlers(ResourceHandlerRegistry registry) {
     registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
     registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
 }

 package com.sky.config;
 ​
 import com.sky.interceptor.JwtTokenAdminInterceptor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
 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;
 ​
 /**
  * 配置类，注册web层相关组件
  */
 @Configuration
 @Slf4j
 public class WebMvcConfiguration extends WebMvcConfigurationSupport {
 ​
     @Autowired
     private JwtTokenAdminInterceptor jwtTokenAdminInterceptor;
 ​
     /**
      * 注册自定义拦截器
      *
      * @param registry
      */
     protected void addInterceptors(InterceptorRegistry registry) {
         log.info("开始注册自定义拦截器...");
         registry.addInterceptor(jwtTokenAdminInterceptor)
                 .addPathPatterns("/admin/**") //拦截路径
                 .excludePathPatterns("/admin/employee/login"); //
     }
 ​
     /**
      * 通过knife4j生成接口文档
      * @return
      */
     @Bean
     public Docket docket() {
         ApiInfo apiInfo = new ApiInfoBuilder()
                 .title("项目接口文档")
                 .version("2.0")
                 .description("项目接口文档")
                 .build();
         Docket docket = new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo)
                 .select()
                 .apis(RequestHandlerSelectors.basePackage("controller路径"))
                 .paths(PathSelectors.any())
                 .build();
         return docket;
     }
 ​
     /**
      * 设置静态资源映射
      * @param registry
      */
     protected void addResourceHandlers(ResourceHandlerRegistry registry) {
         registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
         registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
     }
 }

运行springboot程序后:输入地址 ：https://localhost:8080/doc.html

swagger常用注解

@Api:

用在类上,例如Controller，表示对类的说明。

事例：@Api(tags="类的作用")

@ApiModel:

用在类（实体类）上，用于用途的说明，例如entity,DTO,VO

事例：@ApiModel(description="实体类的作用")-----"xxxxxx时传入的数据模型 "

@ApiModelProperty:

用在属性上，描述属性信息

事例：@ApiModelProperty("说明")

@ApiOperation:

用在方法上，例如Controller的方法，说明方法的用途，作用。

事例：@ApiOperation(value="方法的作用")