How do you turn off swagger-ui in production

Question

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 1

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

Answer 2

If you are working on multiple environments then you can also use @Profile as array

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