自定義Swagger文檔生成

Question

我有一個具有以下配置的彈簧引導應用程序。

@Configuration 
@EnableWebMvc 
@ComponentScan({ "com.xxx.mypackages" }) 
public class MyWebAppConfiguration extends WebMvcConfigurerAdapter { 

} 

在我的項目中，我有一些Web服務和彈簧控制器。我只想在我的web服務類中啓用swagger。目前，它爲休息和控制器類生成文檔。我如何定製？

我在gradle中使用以下依賴項。

compile "com.mangofactory:swagger-springmvc:1.0.2" 

Answer 1

如果你看一下1.0.2 documentation你會發現SwaggerSpringMvcPlugin有includePatterns方法。此方法需要包含的路徑的正則表達式。對於例如如果你曾經爲其他端點像這樣的路徑前綴/rest/some-resource....您可以包括一個模式，像下面

@Bean 
public SwaggerSpringMvcPlugin customImplementation(){ 
    return new SwaggerSpringMvcPlugin(this.springSwaggerConfig) 
    //... more config goes here 
      //regex to identify your rest services path 
      .includePatterns(".*rest.*"); 
} 

所示的代碼片段的東西也將是有益知道，我們要成爲releasing 2.0不久與支持爲swagger spec 2.0。這可能也需要考慮。