Swagger

介绍

按照规范定义接口以及接口相关信息，再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等。
官网：https://swagger.io/

knife4j是为Java MVC框架继承Swagger生成API文档的增强解决方案

使用方式

1、导入knife4j的maven坐标

<dependency>
	<groupld>com.github.xiaoymin</groupld>
	<artifactld>knife4j-spring-boot-starter</artifactld>
	<version>3.0.2</version>
</dependency>

2、导入knife4j相关配置类

@Slf4j
@Configuration
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Bean
    public Docket createRestApi() {
        // 文档类型
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.itheima.reggie.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("瑞吉外卖")
                .version("1.0")
                .description("瑞吉外卖接口文档")
                .build();
    }
}

3、设置静态资源，否则接口文档页面无法显示

registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

4、在LoginCheckFilter中设置不需要处理的请求路径
不处理以下路径

"/doc.html",
"/webjars/**",
"/swagger-resources",
"/v2/api-docs"

swagger常用注解