swagger的简单使用

一、引入依赖

<!--springfox swagger官方Starter-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

二、编写配置

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 通过路径扫描接口
//                .apis(RequestHandlerSelectors.basePackage("com.example.mybatisplusgeneratordemo.project.controller"))
                // 通过在类前加@Api扫描接口
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                // 暴露接口路径给swagger-ui，这里是全局扫描方式
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // Swagger-UI 界面的大标题
                .title("swagger api test")
                // Swagger-UI 界面的一些简单描述信息
                .description("api description")
                // Swagger-UI 界面上所有接口的版本
                .version("1.0")
                .build();
    }
}

三、swagger注解

四、API信息访问地址

http://localhost:8088/swagger-ui/

四、springboot整合swagger2异常

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

• 原因
  Springboot2.6以后将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，导致出错
• 解决方法

spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER