SpringBoot集成Swagger2！！！

最新推荐文章于 2023-04-20 16:00:03 发布

煜帆帆

最新推荐文章于 2023-04-20 16:00:03 发布

阅读量91

点赞数

分类专栏： Java

本文链接：https://blog.csdn.net/weixin_41066675/article/details/109161511

版权

Java 专栏收录该内容

31 篇文章 0 订阅

订阅专栏

1、添加pom文件依赖

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

2、配置SwaggerConfig文件

package com.jw.car.confger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.google.common.base.Predicates;

import springfox.documentation.builders.ApiInfoBuilder;
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;

/**
 * @Author:
 * @Date: 2020/10/19 15:12
 * @Description:
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 屏蔽部分的spring-boot自带的接口
     *
     * @return
     */
    @Bean

    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any())
                .paths(Predicates.not(PathSelectors.regex("/error.*"))).paths(Predicates.not(PathSelectors.regex("/info.*")))
                .paths(Predicates.not(PathSelectors.regex("/autoconfig.*")))
                .paths(Predicates.not(PathSelectors.regex("/health.*")))
                .paths(Predicates.not(PathSelectors.regex("/metrics.*")))
                .paths(Predicates.not(PathSelectors.regex("/mappings.*")))
                .paths(Predicates.not(PathSelectors.regex("/trace.*")))
                .paths(Predicates.not(PathSelectors.regex("/configprops.*")))
                .paths(Predicates.not(PathSelectors.regex("/beans.*"))).paths(Predicates.not(PathSelectors.regex("/env.*")))
                .paths(Predicates.not(PathSelectors.regex("/dump.*")))
                .paths(Predicates.not(PathSelectors.regex("/auditevents.*")))
                .paths(Predicates.not(PathSelectors.regex("/docs.*"))).paths(Predicates.not(PathSelectors.regex("/archaius.*")))
                .paths(Predicates.not(PathSelectors.regex("/features.*")))
                .paths(Predicates.not(PathSelectors.regex("/pause.*"))).paths(Predicates.not(PathSelectors.regex("/refresh.*")))
                .paths(Predicates.not(PathSelectors.regex("/resume.*")))
                .paths(Predicates.not(PathSelectors.regex("/actuator.*")))
                .paths(Predicates.not(PathSelectors.regex("/jolokia.*")))
                .paths(Predicates.not(PathSelectors.regex("/loggers.*")))
                .paths(Predicates.not(PathSelectors.regex("/restart.*")))
                .paths(Predicates.not(PathSelectors.regex("/service-registry/instance-status.*")))
                .paths(Predicates.not(PathSelectors.regex("/logfile.*")))
                .paths(Predicates.not(PathSelectors.regex("/channels.*"))).paths(Predicates.not(PathSelectors.regex("/bus.*")))
                .paths(Predicates.not(PathSelectors.regex("/heapdump.*"))).build();
    }

    /**
     * Swagger2主界面信息,描述api的基本信息用于展示
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("车辆管理服务接口定义和规范").description("")
                .termsOfServiceUrl("http://****.com/").contact(new Contact("", "", "")).version("1.0")
                .license("").build();
    }

}