Deaktivieren Swagger mit Spring MVC

Ich bin mit Swagger mit Spring MVC. Ich möchte selektiv deaktivieren swagger in bestimmten Umgebungen (z.B. Produktion). Wie kann ich das tun?

So ziemlich nichts. Ich bin Total neu zu Stolzieren. Ich habe versucht, um zu sehen, wenn die Einstellung jacksonScalaSupport.setRegisterScalaModule(false) in SwaggerConfig funktionieren würde

InformationsquelleAutor Athomas | 2014-12-12

  1. 34

    , Falls Sie mit 1.x-version von springfox früher Fors-springmvc

    Beim konfigurieren Ihrer swagger spring-mvc-plugin können Sie das enable Methode, die Sie übergeben können, die einen booleschen basierend auf Umwelt/Profil etc.

    @Bean 
public SwaggerSpringMvcPlugin customImplementation(){
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
        .apiInfo(apiInfo())
        .enable(environmentSpeficicBooleanFlag) //<--- Flag to enable or disable possibly loaded using a property file
        .includePatterns(".*pet.*");
}

    Anderen Weg, es zu tun ist mit spring profile

    @Bean
@Profile("production")
public SwaggerSpringMvcPlugin customImplementation(){
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
        .apiInfo(apiInfo())
        .enable(false) //<--- Flag set to false in the production profile
        .includePatterns(".*pet.*");
}

    , Falls Sie mit 2.x-version von springfox

    Beim konfigurieren Ihrer swagger spring-mvc-plugin können Sie das enable Methode, die Sie übergeben können, die einen booleschen basierend auf Umwelt/Profil etc.

    @Bean 
public Docket customImplementation(){
    return new Docket(SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(environmentSpeficicBooleanFlag) //<--- Flag to enable or disable possibly loaded using a property file
        .includePatterns(".*pet.*");
}

    Anderen Weg, es zu tun ist mit spring profile

    @Bean
@Profile("production")
public Docket customImplementation(){
    return new Docket(SWAGGER_2)
        .apiInfo(apiInfo())
        .enable(false) //<--- Flag set to false in the production profile
        .includePatterns(".*pet.*");
}
    Hallo Dilip, Danke für die Antwort. Ich hatte eine Arbeit, um durch die Verwendung eines von der Umgebung flag. Nur wenn das flag true ist, nenne ich das initiallize () - Methode in meiner custom SwaggerSpringMvcPlugin.
    Würden Sie mir, Begehen den tag stolzieren? Siehe hier: stackoverflow.com/documentation/swagger/commit
    Leider funktioniert dies bei mir mit dem Frühling 1.4.1 und Swagger 2.6.1, tritt der Fehler auf, bevor Sie den Konfigurations-Methoden aufgerufen werden.
    @Profile scheint nicht zu funktionieren auf @Bean Methoden. Nach der Frühling docs "Alle @Component oder @Configuration können markiert werden mit @Profile..."
    /swagger-ui.html immer noch verfügbar, aber es gibt keine Methoden. Ist dort Weise, zu verbieten URL ?

    InformationsquelleAutor Dilip Krishnan

  2. 3

    Dilip ' s Antwort ist, was Sie gebeten haben (ich habe es noch nicht getestet noch nicht). Aber ich habe eine zusätzliche Szenario zu bewältigen, die von Interesse sein können: auf einem öffentlichen test-box, ich möchte die Dokumentation aktiviert werden, sondern die privaten.

    Habe ich noch folgende auf meiner WebMvcConfigurerAdapter das sorgt für Basic-Auth

    @Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new SwaggerInterceptor())
            .addPathPatterns("/api-docs");
}

private class SwaggerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (!authHeaderValid(request.getHeader("Authorization"))) {
            response.addHeader("Access-Control-Allow-Origin", "null");
            response.addHeader("WWW-Authenticate", "Basic realm=\"\"");
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            response.getWriter().println("HTTP Status " + HttpServletResponse.SC_UNAUTHORIZED);

            return false;
        }

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { }

    private boolean authHeaderValid(String authorization) {
        if (authorization != null && authorization.startsWith("Basic ")) {
            final String[] values = new String(Base64.getDecoder().decode(authorization.substring("Basic ".length()))).split(":");

            return values[0].equals("username") && values[1].equals("password");
        }

        return false;
    }
}
    Dies könnte leichter umgesetzt durch die Verwendung von Spring Security statt Programmieren eigener Authentifizierung Ansatz?

    InformationsquelleAutor Custard

  3. -2

    Sie versuchen auf diese Weise

    @Configuration
@EnableSwagger
//Loads the spring beans required by the framework
public class MySwaggerConfig
{

    private SpringSwaggerConfig springSwaggerConfig;

    /**
     * Required to autowire SpringSwaggerConfig
     */
    @Autowired
    public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
    {
        this.springSwaggerConfig = springSwaggerConfig;
    }

    /**
     * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
     * framework - allowing for multiple swagger groups i.e. same code base
     * multiple swagger resource listings.
     */
    @Bean
    public SwaggerSpringMvcPlugin customImplementation()
    {
        return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo()).includePatterns(
                ".*?");
    }

    private ApiInfo apiInfo()
    {
        ApiInfo apiInfo = new ApiInfo(
                "xx", 
                "xxxx",
                "My Apps API terms of service", 
                "xxx",
                null,
                null);
        return apiInfo;
    }
}

    pom ist Fors-springmvc. veriosn ist 0.9.5,

    starten Sie den server nach Anfrage http://localhost:8080/appName/api-docs

    Wie kommt diese Antwort zu OP ' s Frage?
    Gibt es nicht etwas in dieser Antwort, die beschreibt, wie Swagger kann aktiviert/deaktiviert werden, basierend darauf, ob die app läuft im dev vs prod?

    InformationsquelleAutor jack

Schreibe einen Kommentar