Swagger接口文档配置

注意配置swagger的版本和本地springboot版本的兼容性

我这里用的是springboot-2.7.12  swagger-3.0.0

如何查看本地springboot版本

1.pom.xml引入依赖

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

2. applicationproperties 添加配置参数

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

3.启动类加@EnableOpenApi注解

常见错误

   注解爆红：引入依赖后，没有刷新，点击右侧maven工具栏，找到项目的生命周期，先点击"clean"清除后点击"install" 

4.创建配置类

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
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;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;
@Configuration
@EnableOpenApi
public class SwaggerConfiguration {
    @Bean
    public Docket createRestApi(){
        System.out.println("---------------swaggerTest---------------");
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();

    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger3接口文档")
                .description("测试的接口文档")
                .version("1.0")
                .build();
    }
    @Bean
    public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
        return new BeanPostProcessor() {
            @Override
            public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
                if (bean instanceof WebMvcRequestHandlerProvider) {
                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
                }
                return bean;
            }

            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(
                    List<T> mappings) {
                List<T> copy = mappings.stream().filter(mapping -> mapping.getPatternParser() == null)
                        .collect(Collectors.toList());
                mappings.clear();
                mappings.addAll(copy);
            }

            @SuppressWarnings("unchecked")
            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
                try {
                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
                    field.setAccessible(true);
                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
                }
                catch (IllegalArgumentException | IllegalAccessException e) {
                    throw new IllegalStateException(e);
                }
            }
        };
    }
}

5.创建测试接口

@Api 标识方法swagger可以扫描

@ApiOpertion 描述接口功能和参数，这样前端自己可以根据描述调用接口

@Api("测试接口")
@RestController//当前类交给springboot管理，并且自动对返回值进行转换
@RequestMapping("/hello")
public class UserController{

    @ApiOperation("测试swagger功能")
    @GetMapping("/testResult")
    public BaseResult testNews(Integer num) {
        Thread thread = new Thread(() -> {
            List<User> list = new ArrayList<>();
            try {
                Thread.sleep(5000);
                System.out.println(Thread.currentThread().getName()+":接口文档测试成功");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        },"myTestThread");
        thread.start();
        return BaseResult.success("开始循环");
    }

6.启动项目，访问http://localhost:8088/swagger-ui/index.html

 注意端口号该为自己配置的端口号，我本地是8088

怎么配置 》》application.properties 添加 server.port=8088

 

7.测试发送请求

点击“try it out" >> "输入请求参数">>点击"execute"

接口返回结果正常，看下控制台，成功创建线程并打印

就这些，感谢你们阅读