swagger只需一篇

阿狗哲哲

已于 2022-03-21 14:14:25 修改

阅读量216

点赞数

分类专栏：实战新技术文章标签： swagger2

于 2022-03-01 18:04:32 首次发布

本文链接：https://blog.csdn.net/qq_52438590/article/details/123211870

版权

实战新技术专栏收录该内容

18 篇文章 0 订阅

订阅专栏

本文介绍了如何在Spring Boot项目中使用Springfox Swagger2进行API文档的配置，重点讲解了如何根据环境变量动态决定是否显示Swagger，并演示了如何为不同分组设置API文档。

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

package com.atqh.qhcommunity.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {

    //配置多个分组
/*
    @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
    }

    @Bean
    public Docket docket2() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
    }
*/

    @Bean
    public Docket docket(Environment environment) {

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


        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("azhe")
                .apiInfo(apiInfo())
                .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.atqh.qhcommunity.controller"))
                .paths(PathSelectors.any())//配置如何通过path过滤
                /*any() // 任何请求都扫描
                 none() // 任何请求都不扫描
                 regex(final String pathRegex) // 通过正则表达式控制
                 ant(final String antPattern) // 通过ant()控制**/
                .build()
                .enable(true)//配置是否启用Swagger，如果是false，在浏览器将无法访问
                /*.enable(b);*/
                ;
    }

    private ApiInfo apiInfo() {
//配置文档信息
        Contact contact = new Contact("阿哲", "2033244875@qq.com", "2033244875@qq.com");
        return new ApiInfo(
                "qhCommunity后端接口文档Swagger", // 标题
                "qhCommunity后端接口", // 描述
                "v1.0", // 版本
                "2033244875@qq.com", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );

    }


}

pom.xml

 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- 引入swagger-ui-layer包 /document.html-->
        访问 http://localhost:8888/document.html
        <dependency>
            <groupId>com.zyplayer</groupId>
            <artifactId>swagger-mg-ui</artifactId>
            <version>1.0.6</version>
        </dependency>