自定义Swagger文档生成

时间:2015-04-21 10:34:53

标签: spring-mvc spring-boot swagger

我有一个带有以下配置的春季启动应用程序。

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

}

在我的项目中,我有一些Web服务和弹簧控制器。我希望只在我的Web服务类中启用swagger。目前,它为rest类和控制器类生成文档。我该如何定制?

我在gradle中使用了以下依赖项。

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

1 个答案:

答案 0 :(得分: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,那将会很有用。这也许需要考虑。