springboot整合swagger2

mgx_718

已于 2023-09-20 16:30:23 修改

阅读量108

点赞数

分类专栏： springboot整合文章标签： spring boot java

于 2023-09-18 11:12:16 首次发布

本文链接：https://blog.csdn.net/qq_42405688/article/details/132966891

版权

springboot整合专栏收录该内容

6 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中引入Swagger2库，配置SwaggerConfig，包括添加依赖、配置信息、注解使用以及查看Swagger效果。重点讲解了如何通过@Configuration、@EnableSwagger2和ConditionalOnProperty实现Swagger的启用与隐藏。

摘要由CSDN通过智能技术生成

1、引入依赖

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

2、SwaggerConfig配置

package com.mgx.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author mgx
 * @date 2023/9/18 10:24 AM
 */
@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable",havingValue = "true")
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否开启 (true 开启  false隐藏。生产环境建议隐藏)
                //.enable(false)
                .select()
                //扫描的路径包,设置basePackage会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.basePackage("com.mgx"))
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //设置文档标题(API名称)
                .title("SpringBoot中使用Swagger2接口规范")
                //文档描述
                .description("供前后端进行联调的文档")
                //服务条款URL
                .termsOfServiceUrl("http://localhost:8080/")
                //版本号
                .version("1.0.0")
                .build();
    }

}

解释说明：

@Configuration为配置类注解，springboot启动时会进行加载。

@EnableSwagger2为swagger注解，加上该注解时，使用swagger2才会生效。

@ConditionalOnProperty(name = "swagger.enable",havingValue = "true")，该注解也是springboot中用于配置类的注解，主要作用为条件配置，例如该表达的意思为：在配置文件中名为swagger.enable为ture时，加载该类。