Swagger2.0 的Config简单配置

最新推荐文章于 2025-03-20 13:45:32 发布

原创最新推荐文章于 2025-03-20 13:45:32 发布 · 3.2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#java #restful #swagger2

Swagger2 专栏收录该内容

2 篇文章

订阅专栏

本文档展示了如何在SpringBoot项目中使用Swagger2配置自定义的API信息，并通过Docket bean控制Swagger的启用状态，以及指定扫描的包和路径。配置包括Swagger的作者信息、API描述、版本等，帮助开发者生成清晰的RESTful API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger2.0自定义的apiInfo的Config实例如下所示：

@Configuration
@EnableSwagger2  //开启swagger2
public class SwaggerConfig {

    //配置了Swagger的Docket的bean实例
    //enable 是否启动swagger
    @Bean
    public Docket docket(Environment environment){

        // 设置要显示swagger的环境
        //Profiles of = Profiles.of("dev", "test");
        // 判断当前是否处于该环境
        // 通过 enable() 接收此参数判断是否要显示
        boolean flag = environment.acceptsProfiles("dev");

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(flag)
                .select()
                //RequestHandlerSelectors,配置需要扫描接口的方式
                //basePackage:指定要扫描的包
                //any():扫描全部
                //none():不扫描
                //withClassAnnotation:扫描类上的注解
                //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
                //withMethodAnnotation：扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.chenjl.swagger.controller"))
                //paths()：过滤什么路径
                .paths(PathSelectors.ant("/chenjl/**"))
                .build();
    }

    /**
     * 配置swagger信息=apiInfo
     */
    private ApiInfo apiInfo(){

        //作者信息
        Contact contact = new Contact("chenjl", "https://blog.youkuaiyun.com/weixin_44874132/article/details/115443940", "1212313@qq.com");

        return new ApiInfo(
                "chenjl的SwaggerAPI文档",
                "最怕一生碌碌无为，还安慰自己平凡可贵。",
                "v1.0",
                "https://blog.youkuaiyun.com/weixin_44874132/article/details/115443940",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<VendorExtension>());
    }
}

运行结果如下图所示：
在这里插入图片描述

附上本代码的pom文件，方便小伙伴们亲测：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.kuang</groupId>
    <artifactId>swagger-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <name>springboot-swagger2</name>
    <description>继承Swagger2</description>

    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.0.4.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>


</project>