Swagger 的依赖

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

Swagger 的配置

@Configuration
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 判断是否启动swagger
                .enable(true)
                .select()
                // 需要生成访问测试的 Controller 所在包
                .apis(RequestHandlerSelectors.basePackage("com.haha.xixi")) 
                .paths(PathSelectors.any())
                .build();
    }
    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger 生成的测试页面的标题")
                .description("页面的描述")
                .version("1.0")
                .termsOfServiceUrl("填写url")
                .build();
    }
}

Swagger 生成的测试页面地址

http://项目IP：项目端口号/swagger-ui.html

Swagger 的注解

1. @Api(description=“讲师管理”)加在 controller 上
2. @ApiOperation(value = “所有讲师列表”) 加在 controller 的方法上
3. @ApiParam(name = “id”, value = “讲师ID”, required = true)加在 controller 的方法请求参数上
4. @ApiModelProperty(value = “章节ID”) 加在 类的成员属性上

遇到过的问题

提示 documentationPluginsBootstrapper 空指针异常

# 原因是在 springboot2.6.X 中将 SpringMVC 默认路径匹配策略从 AntPathMatcher 更改为 PathPatternParser
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

• 更多详细内容参考官网