Swagger配置

一定一定要注意各个模块的版本,否则会直接启动不起来或者报各种各样奇怪的错误!!!!

版本:SpringBoot 2.3.12 Mybatis 8.0.31 swagger 2.7.0

导入Maven依赖

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

配置application.yml文档

swagger:
  basePackage: com.pickle.controller
  title: pickle
  version: V1.0

编写配置类

@Configuration
@EnableSwagger2
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {
    @Value("${basePackage}")
    private String basePackage;  //controller所在的包
    @Value("${title}")
    private String title;//当前文档的标题
    @Value("${version}")
    private String version; //当前文档的版本
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) //指定构建api文档的详细信息的方法:apiInfo()
                .select()
                //指定要生成api接口的包路径,这里把controller作为包路径,生成controller中的所有接口
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }
    /*
      构建api文档的详细信息
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title(title) //设置标题
                .version(version) //设置版本
                .build();
    }
}
posted @ 2024-03-13 16:13  破忒头头  阅读(47)  评论(0)    收藏  举报