spring boot整合swagger

依赖

    
    
        io.springfox
        springfox-swagger2
        2.9.2
    
    
    
        io.springfox
        springfox-swagger-ui
        2.9.2
    
    
    
        com.github.xiaoymin
        swagger-bootstrap-ui
        1.9.2
    

配置端口号

server.port=1313
#启动会报错（原因：Springfox使用的路径匹配基于AntPathMatcher，而Spring Boot 2.6.X使用的是PathPatternMatcher。）
#org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

启动类添加注解（ @EnableSwagger2 ）

@EnableSwagger2
@SpringBootApplication
public class JavaApplication {

    public static void main(String[] args) {
        SpringApplication.run(JavaApplication.class, args);
    }

}

注解介绍

/**
 * Api注解：定义接口名称
 * ApiOperation注解：定义方法名称
 * ApiImplicitParam注解：定义param参数的各个属性
 *
 * ApiModel注解：定义对象名称
 * ApiModelProperty注解：定义参数名称
 */
@Api(tags = "测试接口")
@RestController
public class TestController {

    @ApiOperation(value = "测试01")
    @GetMapping("/test01")
    public String Test01(){
        return "Test01";
    }

}

访问地址：http://localhost:1313/swagger...
或者http://localhost:1313/doc.html

新增配置类

/**
 * @EnableSwagger2：开启swagger，此处也需要使用。
 * @Profile("swagger")：指定组件在哪个环境的情况下才能被注册到容器中，不指定，任何环境下都能注册这个组件。
 * 
 * spring.profiles.active=swagger
 *
 */
@Configuration
@EnableSwagger2
@Profile("swagger")
public class SwaggerConfig {
    /**
     * 创建API应用 apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        // 选择那些路径和api会生成document
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select()
                // 对所有api进行监控
                .apis(RequestHandlerSelectors.any())
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build()
                // 配置token
                .globalOperationParameters(setHeaderToken());
    }

    /**
     * 配置token
     *
     * @return
     */
    private List setHeaderToken() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List pars = new ArrayList<>();
        tokenPar.name("Authorization").description("token").modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build();
        pars.add(tokenPar.build());
        return pars;
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("测试接口文档").description("测试接口文档").version("1.0").build();
    }

}