springboot配置swagger2

最新推荐文章于 2024-09-07 15:19:16 发布

lucky_shanshan

最新推荐文章于 2024-09-07 15:19:16 发布

阅读量148

点赞数 2

分类专栏： springboot 文章标签： spring swagger2 java

本文链接：https://blog.csdn.net/lucky_shanshan/article/details/119028282

版权

springboot 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、配置maven依赖

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

二、配置config类

@Configuration
@EnableSwagger2
public class Swagger2Config {
    /**
     * api文档实例
     * @return
     */
    @Bean
    public Docket createRestfulApi() {
        //文档类型：DocumentationType.SWAGGER_2
        return new Docket(DocumentationType.SWAGGER_2)
                //api信息
                .apiInfo(apiInfo())
                //构建api选择器
                .select()
                //api选择器选择api的包
                //.apis(RequestHandlerSelectors.basePackage("com.test.fe"))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //api选择器选择包路径下任何api显示在文档中
                .paths(PathSelectors.any())
                //创建文档
                .build();
    }

    /**
     * 接口的相关信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("****接口文档")
                .description("****接口swagger2文档")
                .version("1.0")
                .build();
    }

三、访问路径

http://localhost:8080/swagger-ui.html#/

四、注意事项

用3.0.0的swagger依赖版本这个配置不适用，访问页面会报404错误