我如何在Spring Boot项目的生产中禁用Swagger-UI

Question

我有一个SpringBootRESTAPI应用程序，我集成了Swagger作为文档，还用它用Swagger UI测试API。

现在，我的任务是在我们的生产环境(公共域)上禁用Swagger-UI，并在私有IP上的开发环境中启用它。

Answer 1

只需使用@Profile注释注释您的配置

@Profile({"local", "dev"})

Answer 2

为了实现它，我在我的 Swagger 配置类和 application.properties 文件中进行了下面提到的更改。

我的pom.xml，我在其中添加了下面的依赖项来集成swagger。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

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

在我的application-ev中。属性文件，我添加了一个布尔值为true的键值对

use-swagger=true

在我的应用程序产品中。属性文件，我将值更改为false

use-swagger=false

现在，最后在我的SwaggerConfig类中，我使用了上面的键来启用/禁用Swagger UI

@Configuration
public class SwaggerConfig  implements EnvironmentAware {

    private Environment environment;

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.jkoder.example.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo())
                .enable(Boolean.parseBoolean(environment.getProperty("use-swagger")));
    }


    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
}

enable（Boolean.parseBoolean（environment.getProperty（“use-swagger”））此函数允许您在所需的环境中启用或禁用swagger ui。

为了执行Spring Boot REST Api应用程序，我们使用了以下命令

在开发环境中-

nohup java -jar -Dspring.profiles.active=dev target/myapp-1.0.jar &

在生产环境中-

nohup java -jar -Dspring.profiles.active=prod target/myapp-1.0.jar &

Answer 3

使用Swagger vr-3.0.0，我们可以在相应的环境配置文件application.properties文件中添加spring fox . documentation . enabled = false/true。

类似于prod服务器应用程序prod。属性文件

springfox.documentation.enabled=false 

对于开发服务器application-dev.properties文件

springfox.documentation.enabled=true

并通过在 VM 参数中指定配置文件来运行应用

-Dspring.profiles.active=prod/dev