swagger2入门

1.pom配置

  <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!--swagger ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2.配置编写

package com.hexu.demo666.config;

import com.google.common.base.Predicates;
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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Classname SwaggerConfig
 * @Description TODO
 * @Author 86176
 * @Date 2022-01-22 19:25
 * @Version 1.0
 **/
@Configuration

@EnableSwagger2

public class SwaggerConfig {


    @Bean

    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)

                .groupName("webApi")

                .apiInfo(webApiInfo())

                .select()

                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))

                .paths(Predicates.not(PathSelectors.regex("/error.*")))

                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()

                .title("标题")

                .description("描述")

                .version("1.0")

                .contact(new Contact("Hexu", "XXX", "XXX@qq.com"))

                .build();

    }

}

3.启动如下图报错

配置文件加上 spring.mvc.pathmatch.matching-strategy=ant_path_matcher

4.常用注解

注解	描述
@Api(“参数”)	标记在类上
@ApiOperation(“参数”)	标记在方法上
@ApiParam(“参数”)	标记属性

访问404?

加入以下配置访问成功

package com.hexu.demo666.config;

/**
 * @Classname WebMvcConfig
 * @Description TODO
 * @Author 86176
 * @Date 2022-02-12 10:47
 * @Version 1.0
 **/
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * Spring MVC 配置
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    /**
     * 配置静态资源访问路径
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 静态资源访问路径和存放路径配置
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/","classpath:/public/");
        // swagger访问配置
        registry.addResourceHandler("/**").addResourceLocations("classpath:/META-INF/resources/","classpath:/META-INF/resources/webjars/");
    }
}