首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Swagger操作排序

Swagger操作排序
EN

Stack Overflow用户
提问于 2017-01-23 07:46:19
回答 3查看 17.4K关注 0票数 14

如何按字母顺序对我的操作进行排序,例如、GETPOSTPUT

我读过这篇文章,但它是用HTML写的,但在我的例子中,我已经将Swagger集成到Spring中,所以我需要在创建一个文档时对它进行排序。

Swagger中的API方法排序

然后,我在文档中注意到了这个方法operationOrdering(),但是我仍然无法使它工作。

EN

回答 3

Stack Overflow用户

发布于 2018-10-11 13:01:33

我使用Springfox版本2.8.0,下面的代码片段适用于我的文档API:

代码语言:javascript
运行
复制
@Bean
UiConfiguration uiConfig() {
    return UiConfigurationBuilder
            .builder()
            .operationsSorter(OperationsSorter.METHOD)

            ...

            .build();
}

有两个可能的值:

  • OperationsSorter.ALPHA -按路径按字母顺序排序API端点
  • OperationsSorter.METHOD -用方法按字母顺序排序API端点

OperationsSorter.METHOD是你要找的东西。

使用替代使用operationOrdering()

代码语言:javascript
运行
复制
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .paths(PathSelectors.any())
        .build()

        ...

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

但是,由于Springfox中的一个bug似乎仍然是活动的(操作顺序不起作用),所以这是行不通的。

票数 8
EN

Stack Overflow用户

发布于 2021-03-14 17:28:36

使用application.properties中的Spring 2.4OpenAPI,可能会对以下属性感兴趣:

  • springdoc.swagger-ui.tagsSorter=alpha
  • springdoc.swagger-ui.operations-sorter=alpha
票数 6
EN

Stack Overflow用户

发布于 2020-02-07 09:35:20

代码语言:javascript
运行
复制
@Bean
public UiConfiguration uiConfig() {
    return UiConfigurationBuilder
            .builder()
            .operationsSorter(OperationsSorter.METHOD)
            .build();
}

这对我有用。我使用SpringBoot2.2.0.M6,Swagger 2.9.2

票数 4
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/41801387

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档