swagger使用

swagger使用

（新手笔记,狂神搬运工）
**本篇依据狂神瑞吉外卖项目优化部分进行记录

狂神说Java

介绍

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

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

swagger使用

swagger配置

1、导入maven坐标

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

2、导入knife4j相关配置类（WebMvcConfig）
在mvc配置文件WebMvcConfig中开启swagger和knife4j

@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、设置静态资源（否则接口文档页面无法访问）
设置静态资源映射（WebMvcConfig类中的addResourceHandlers方法)，否则接口文档页面无法访问。

        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

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

访问localhost:8080/doc.html

在这里就可以看到接口信息和进行接口测试了。

swagger常用注解

在类和方法上加上相关注解进行配置