swagger

==保证依赖版本，版本不一致会出现莫名其妙的问题==

spring boot 版本低于2.6
swagger 使用 2.9.2

<!-- swagger -->
<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>

@EnableSwagger2添加在启动

@EnableSwagger2
@SpringBootApplication
public class BlogSquareApplication {

    public static void main(String[] args) throws NoSuchAlgorithmException {
        ConfigurableApplicationContext run = SpringApplication.run(BlogSquareApplication.class,
                args);
    }

}

添加swagger-config

Configuration // 标明是配置类
@EnableSwagger2 //开启swagger功能
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // DocumentationType.SWAGGER_2 固定的，代表swagger2
//                .groupName("分布式任务系统") // 如果配置多个文档的时候，那么需要配置groupName来分组标识
                .apiInfo(apiInfo()) // 用于生成API信息
                .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
                .apis(RequestHandlerSelectors.basePackage("com.spr.blogsquare.controller")) // 用于指定扫描哪个包下的接口
                .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
                .build();
    }
    /**
     * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("BLOG项目API") //  可以用来自定义API的主标题
                .description("XX项目SwaggerAPI管理") // 可以用来描述整体的API
                .termsOfServiceUrl("") // 用于定义服务的域名
                .version("1.0") // 可以用来定义版本。
                .build(); //
    }
}

PreviousstudyLinks Next中间件

Last updated 2 years ago

 <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>

@EnableSwagger2 @SpringBootApplication public class BlogSquareApplication { public static void main(String[] args) throws NoSuchAlgorithmException { ConfigurableApplicationContext run = SpringApplication.run(BlogSquareApplication.class, args); } }

Configuration // 标明是配置类 @EnableSwagger2 //开启swagger功能 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 固定的，代表swagger2 // .groupName("分布式任务系统") // 如果配置多个文档的时候，那么需要配置groupName来分组标识 .apiInfo(apiInfo()) // 用于生成API信息 .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档 .apis(RequestHandlerSelectors.basePackage("com.spr.blogsquare.controller")) // 用于指定扫描哪个包下的接口 .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里 .build(); } /** * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本 * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("BLOG项目API") // 可以用来自定义API的主标题 .description("XX项目SwaggerAPI管理") // 可以用来描述整体的API .termsOfServiceUrl("") // 用于定义服务的域名 .version("1.0") // 可以用来定义版本。 .build(); // } }