使用xml配置的Spring安全性的Swagger文档

时间:2015-04-29 16:42:32

标签: xml spring-security swagger

我尝试使用swagger,spring-rest-doc和spring-fox为基于spring mvc的休息服务生成文档。但是,我的挑战是记录基于spring security xml配置的端点。到目前为止,春天狐狸一直是赢家。但它记录了Spring安全支持的所有方法。关于如何过滤掉我需要的任何想法?

例如,当我使用/swagger-ui.html提取文档页面时 我看到以下几组:

  • basic-error-controller
  • 授权端点
  • 白色标签批准端点
  • 健康检查工具

其中我只需要授权端点和健康检查器。有任何想法吗?

1 个答案:

答案 0 :(得分:0)

您是否查看了文档to transition to 2.0

@Bean
public Docket swaggerSpringMvcPlugin() {
    return new Docket(DocumentationType.SWAGGER_2)
        .groupName("business-api")
        .select() 
           //Ignores controllers annotated with @CustomIgnore
          .apis(not(withClassAnnotation(CustomIgnore.class)) 
          // and by paths
          .paths(paths()) 
          .build()
        .apiInfo(apiInfo())
        .securitySchemes(securitySchemes())
        .securityContext(securityContext());
}

您应该能够使用RequestHandlerSelectors来过滤您需要的api 使用以下谓词

  • 类注释,例如上面显示的示例withClassAnnotation
  • 方法注释(用于过滤操作)withMethodAnnotation
  • by base package basePackage

我怀疑你已经找到了如何让它与xml配置一起使用(在这种情况下,这个问题的标题是不正确的)。如果您需要更多示例,还有很多demos and examples。如果您还有其他问题,问题跟踪器可能比stackoverflow.com更好,我们不经常这样做。