Spring Boot 禁用 Swagger 的三种方式

昨天 1315阅读


禁用方法1:

======

使用注解 @Value() 推荐使用

package com.dc.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

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

  • @version V1.0

  • @Package com.dc.config

  • @date 2018/1/16 17:33

  • @Description: 主要用途:开启在线接口文档和添加相关配置

    */

    @Configuration

    @EnableSwagger2

    public class Swagger2Config extends WebMvcConfigurerAdapter {

    @Value(“${swagger.enable}”)

    private Boolean enable;

    @Bean

    public Docket createRestApi() {

    return new Docket(DocumentationType.SWAGGER_2)

    .enable(enable)

    .apiInfo(apiInfo())

    .select()

    .apis(RequestHandlerSelectors.basePackage(“com.dc.controller”))

    .paths(PathSelectors.any())

    //.paths(PathSelectors.none())

    .build();

    }

    private ApiInfo apiInfo() {

    return new ApiInfoBuilder()

    .title(“auth系统数据接口文档”)

    .description(“此系统为新架构Api说明文档”)

    .termsOfServiceUrl(“”)

    .contact(new Contact(“陈永佳 chen867647213@163.com”, “”, “https://blog.csdn.net/Mrs_chens”))

    .version(“1.0”)

    .build();

    }

    /**

    • swagger ui资源映射

    • @param registry

      */

      @Override

      public void addResourceHandlers(ResourceHandlerRegistry registry) {

      registry.addResourceHandler(“swagger-ui.html”)

      .addResourceLocations(“classpath:/META-INF/resources/”);

      registry.addResourceHandler(“/webjars/**”)

      .addResourceLocations(“classpath:/META-INF/resources/webjars/”);

      }

      /**

      • swagger-ui.html路径映射,浏览器中使用/api-docs访问

      • @param registry

        */

        @Override

        public void addViewControllers(ViewControllerRegistry registry) {

        registry.addRedirectViewController(“/api-docs”,“/swagger-ui.html”);

        }

        }


        禁用方法2:

        ======

        使用注解 @Profile({“dev”,“test”}) 表示在开发或测试环境开启,而在生产关闭。(推荐使用)

        package com.dc.config;

        import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;

        import org.springframework.context.annotation.Bean;

        import org.springframework.context.annotation.Configuration;

        import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

        import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;

        import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

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

        • @version V1.0

        • @Package com.dc.config

        • @date 2018/1/16 17:33

        • @Description: 主要用途:开启在线接口文档和添加相关配置

          */

          @Configuration

          @EnableSwagger2

          @Profile({“dev”,“test”})

          public class Swagger2Config extends WebMvcConfigurerAdapter {

          @Bean

          public Docket createRestApi() {

          return new Docket(DocumentationType.SWAGGER_2)

          .apiInfo(apiInfo())

          .select()

          .apis(RequestHandlerSelectors.basePackage(“com.dc.controller”))

          .paths(PathSelectors.any())

          //.paths(PathSelectors.none())

          .build();

          }

          小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

          深知大多数初中级Java工程师,想要提升技能,往往是自己摸索成长,但自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

          因此收集整理了一份《2024年最新Java开发全套学习资料》送给大家,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

          Spring Boot 禁用 Swagger 的三种方式

          Spring Boot 禁用 Swagger 的三种方式

          Spring Boot 禁用 Swagger 的三种方式

          由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频

          如果你觉得这些内容对你有帮助,可以添加下面V无偿领取!(备注Java)

          Spring Boot 禁用 Swagger 的三种方式

          总结:绘上一张Kakfa架构思维大纲脑图(xmind)

          Spring Boot 禁用 Swagger 的三种方式

          其实关于Kafka,能问的问题实在是太多了,扒了几天,最终筛选出44问:基础篇17问、进阶篇15问、高级篇12问,个个直戳痛点,不知道如果你不着急看答案,又能答出几个呢?

          若是对Kafka的知识还回忆不起来,不妨先看我手绘的知识总结脑图(xmind不能上传,文章里用的是图片版)进行整体架构的梳理

          梳理了知识,刷完了面试,如若你还想进一步的深入学习解读kafka以及源码,那么接下来的这份《手写“kafka”》将会是个不错的选择。

          • Kafka入门

          • 为什么选择Kafka

          • Kafka的安装、管理和配置

          • Kafka的集群

          • 第一个Kafka程序

          • Kafka的生产者

          • Kafka的消费者

          • 深入理解Kafka

          • 可靠的数据传递

          • Spring和Kafka的整合

          • SpringBoot和Kafka的整合

          • Kafka实战之削峰填谷

          • 数据管道和流式处理(了解即可)

            Spring Boot 禁用 Swagger 的三种方式

            Spring Boot 禁用 Swagger 的三种方式

            • 为什么选择Kafka

            • Kafka的安装、管理和配置

            • Kafka的集群

            • 第一个Kafka程序

            • Kafka的生产者

            • Kafka的消费者

            • 深入理解Kafka

            • 可靠的数据传递

            • Spring和Kafka的整合

            • SpringBoot和Kafka的整合

            • Kafka实战之削峰填谷

            • 数据管道和流式处理(了解即可)

              [外链图片转存中…(img-EtDGiJOw-1710739095135)]

              [外链图片转存中…(img-HOexjWxt-1710739095135)]

              本文已被CODING开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录

VPS购买请点击我

文章版权声明:除非注明,否则均为主机测评原创文章,转载或复制请以超链接形式并注明出处。

目录[+]