Spring boot Swagger怎么扫描包下面的指定类(不想生成包下所有controller的接口)

发布于 2022-01-05 08:25:45 字数 92 浏览 674 评论 4

在使用spring boot的时候,利用Swagger生成接口文档, 只想生成指定类的接口文件。
如图:包下面所有的都会生成
怎么做,得到指定类的接口了。

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(4

顾挽 2022-01-07 19:31:49

引用来自“樱木花道VS康”的评论

@ApiIgnore

忽略扫描该controller,用在类上

晚风撩人 2022-01-07 17:43:19

It is not always desirable to expose the documentation for your entire API. You can restrict Swagger’s response by passing parameters to the apis() and paths() methods of the Docket class.

As seen above, RequestHandlerSelectors allows using the any or none predicates, but can also be used to filter the API according to the base package, class annotation, and method annotations.

PathSelectors provides additional filtering with predicates which scan the request paths of your application. You can use any()none(), regex(), or ant().

In the example below, we will instruct Swagger to include only controllers from a particular package, with specific paths, using the ant() predicate.

1

2

3

4

5

6

7

8

@Bean

public Docket api() {               

    return new Docket(DocumentationType.SWAGGER_2)         

      .select()                                      

      .apis(RequestHandlerSelectors.basePackage("org.baeldung.web.controller"))

      .paths(PathSelectors.ant("/foos/*"))                    

      .build();

}

策马西风 2022-01-07 17:21:25
@ApiIgnore

忽略扫描该controller,用在类上

疑心病 2022-01-07 14:33:48

有扫controller的

 

 

 

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.XXX.web"))
                .paths(PathSelectors.any())
                .build();
    }}

   

 

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文