How do you turn off swagger-ui in production

java spring spring-boot swagger swagger-ui
user301693 picture user301693 · Jun 13, 2016 · Viewed 47.3k times · Source

I have swagger plugged in to my spring boot application. Spring boot allows you to have property files for each environment that you have. Is there a way to disable swagger for a production environment?

Answer

luboskrnac picture luboskrnac · Jun 13, 2016

Put your swagger configuration into separate configuration class and annotate it with @Profile annotation -> so that it will be scanned into Spring context only in certain profiles.

Example:

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

You can than define profile your Spring Boot app is operating in via command line: --spring.profiles.active=dev or via config file: spring.profiles.active=dev.

Read this section of Spring Boot docs for more info about @Profile

Related questions

How to fully disable swagger-ui in spring-boot?(/swagger-ui.html should return 404)

I have read following topic: Disabling Swagger with Spring MVC and I wrote: @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.project.name.controller")) .paths(PathSelectors.ant("/api/**")) .build() .apiInfo(apiInfo()) .enable(false); } But …

Read More
SpringFox Swagger - Optional and Mandatory fields in model

I used SpringFox library for rest documentation of my spring boot app. When I click on model , all the elements are being returned as optional. Is there a way to display required elements as mandatory? Is there any additional configuration …

Read More
Add Swagger Basic AUTH to Spring Boot App

Requirements: Spring Boot application with Springfox Add BASIC authentication to Swagger Pass on all other requests Code: implemented @EnableWebSecurity @Configuration public class SecurityConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http .authorizeRequests() .antMatchers("/swagger-resources/*", "*.html", "/api/v1/…

Read More