当前位置:  开发笔记 > 编程语言 > 正文

Swagger API操作排序

如何解决《SwaggerAPI操作排序》经验,为你挑选了1个好方法。

如何按字母顺序对方法进行排序,例如DELETEGETPOSTPUT

我已经阅读了这篇文章,但是它是HTML格式的,但就我而言,我将Swagger集成到了Spring Boot中,因此在创建Docket时需要对其进行排序。

在Swagger UI中对API方法进行排序

然后我operationOrdering()在Docket中注意到了这种方法,但是我仍然无法使它起作用。



1> Vladas Maier..:

我使用的是Springfox 2.8.0版,以下代码段适用于我记录的API:

@Bean
UiConfiguration uiConfig() {
    return UiConfigurationBuilder
            .builder()
            .operationsSorter(OperationsSorter.METHOD)

            ...

            .build();
}

有两个可能的值:

OperationsSorter.ALPHA-通过路径按字母顺序对API端点进行排序

OperationsSorter.METHOD-通过方法按字母顺序对API端点进行排序

OperationsSorter.METHOD 是您要寻找的。


使用operationOrdering()以下替代方法:

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build()

        ...

        .operationOrdering(new Ordering() {
            @Override
            public int compare(Operation left, Operation right) {
                return left.getMethod().name().compareTo(right.getMethod().name());
            }
        })
}

但是,由于Springfox中的一个错误似乎仍然处于活动状态(操作排序不起作用),因此无法正常工作。

推荐阅读
k78283381
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有