springboot + swagger3 学习

最新推荐文章于 2024-07-22 08:30:00 发布

兔子先生9959

最新推荐文章于 2024-07-22 08:30:00 发布

阅读量251

点赞数

分类专栏：学习文章标签： Springfox OpenAPI Spring Boot 文档自动化依赖配置

本文链接：https://blog.csdn.net/qq_43028226/article/details/112688494

版权

学习专栏收录该内容

11 篇文章 0 订阅

订阅专栏

相比2来说省去了配置

添加依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

只需要在启动类上添加@EnableOpenApi

@SpringBootApplication
@EnableOpenApi
public class AlyApplication {

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

}

新版的访问地址也有所变化
http://localhost:8888/swagger-ui/index.html#/
在这里插入图片描述

2.

创建配置类SwaggerConfig

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo()).enable(true)
                .select()
                //apis： 添加swagger接口提取范围
                .apis(RequestHandlerSelectors.basePackage("com.example.aly"))
                //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("XX项目接口文档")
                .description("XX项目描述")
                .contact(new Contact("作者", "作者URL", "作者Email"))
                .version("1.0")
                .build();
    }
}