java - errors - ¿Cómo se apaga swagger-ui en producción?

swagger return json

Question

Me he jodido enchufado a mi aplicación de arranque de primavera. Spring Boot le permite tener archivos de propiedades para cada entorno que tenga. ¿Hay una manera de deshabilitar Swagger para un entorno de producción?

Answer 1

Esta es mi clase de configuración:

@Configuration
@Profile("swagger")
@EnableSwagger2
public class SwaggerConfig {

    @Value("${info.build.version}")
    private String buildVersion;

    @Bean
    public Docket documentation() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(regex("/rest/.*"))
                .build()
                .pathMapping("/")
                .apiInfo(metadata());
    }

    private ApiInfo metadata() {
        return new ApiInfoBuilder()
                .title("API documentation of our App")
                .description("Use this documentation as a reference how to interact with app''s API")
                .version(buildVersion)
                .contact(new Contact("Dev-Team", "https://dev-website", "dev@mailbox"))
                .build();
    }
}

Donde sea que necesite Swagger, agrego el perfil swagger a la variable de entorno SPRING_PROFILES_ACTIVE

Answer 2

Si está trabajando en múltiples entornos, también puede usar @Profile como matriz

@Configuration
@EnableSwagger2
@Profile({"dev","qa"})
public class SwaggerConfig {
   // your swagger configuration
}

Answer 3

Coloque la configuración de Swagger en una clase de configuración separada y @Profile anotaciones con la anotación @Profile -> para que se escanee en el contexto de Spring solo en ciertos perfiles.

Ejemplo:

@Configuration
@EnableSwagger2
@Profile("dev")
public class SwaggerConfig {
    // your swagger configuration
}

Puede definir el perfil en el que funciona su aplicación Spring Boot a través de la línea de comandos: --spring.profiles.active=dev o mediante el archivo de configuración: spring.profiles.active=dev .

Lea esta sección de los documentos de Spring Boot para obtener más información acerca de @Profile