Swagger API Operations Ordering

Question

How do I sort my operation by method alphabetically e.g. DELETE, GET, POST, PUT.

I have read from this post but it is in HTML but in my case, I have integrated Swagger into Spring Boot so I need to sort it when creating a Docket.

Sort API methods in Swagger UI

Then I noticed this method operationOrdering() in Docket, but I still cannot make it work.

score 9 · Answer 1 · answered Mar 14 '21 at 17:28

9

With Spring Boot 2.4 and OpenAPI the following properties in application.properties may be of interest:

springdoc.swagger-ui.tagsSorter=alpha
springdoc.swagger-ui.operations-sorter=alpha

answered Mar 14 '21 at 17:28

mp31415

6,531
1
44
34

1

I'm not sure if there's a difference between: `springdoc.swagger-ui.operationsSorter=alpha` & `springdoc.swagger-ui.operations-sorter=alpha` but the former is used on their docs:https://springdoc.org/faq.html#_how_can_i_sort_endpoints_alphabetically – Sami Oct 28 '22 at 00:42
1

`operations-sorter` sorts the endpoints from one class, `tags-sorter` sort the classes inside swagger ui. With both of them you sort first the class title, and inside each one, the endpoints. – King Midas Jul 10 '23 at 11:16

Vladas Maier · Answer 2 · 2018-10-31T12:47:43.260

8

I am using Springfox version 2.8.0 and following code snippet works for my documented API:

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

            ...

            .build();
}

There are 2 possible values:

OperationsSorter.ALPHA - sorts API endpoints alphabetically by path
OperationsSorter.METHOD - sorts API endpoints alphabetically by method

OperationsSorter.METHOD is what you are looking for.

Alternative by using operationOrdering():

@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());
            }
        })
}

However, this does not work because of a bug in Springfox which seems to be still active (Operation ordering is not working).

edited Oct 31 '18 at 12:47

answered Oct 11 '18 at 13:01

Vladas Maier

2,054
2
22
34

@DanielHári do you mean the `OperationsSorter` or the alternative? – Vladas Maier Feb 26 '19 at 14:23
Neither of them works, it sorts all operations by url. – Daniel Hári Feb 26 '19 at 14:29
@DanielHári I am using Springfox version 2.9.2 in my project and the `OperationSorter` method works for me. Both `ALPHA` and `METHOD`. Cannot reproduce. – Vladas Maier Feb 26 '19 at 14:36
Here is my config that not works: https://gist.github.com/haridaniel/0e8c9ae63ff8daac866c2b6ff53ccc2c – Daniel Hári Feb 26 '19 at 14:43

score 4 · Answer 3 · answered Feb 07 '20 at 09:35

4

@Bean
public UiConfiguration uiConfig() {
    return UiConfigurationBuilder
            .builder()
            .operationsSorter(OperationsSorter.METHOD)
            .build();
}

This works for me. I'm using Spring Boot 2.2.0.M6, Swagger UI 2.9.2

answered Feb 07 '20 at 09:35

Tran Dinh

41
2

score 0 · Answer 4 · answered Dec 17 '22 at 10:29

0

springdoc.swagger-ui.operations-sorter does not work in v3/api-docs.

For alphabetical ordering in v3/api-docs use :

springdoc.writer-with-order-by-keys=true

answered Dec 17 '22 at 10:29

Shapur

498
7
17

this alphabetically sorts schema properties also along with the http method. – EmeraldTablet May 03 '23 at 10:06

score 0 · Answer 5 · answered Feb 15 '23 at 15:53

0

Add this to your application.properties file

springdoc.swagger-ui.operationsSorter=method
springdoc.swagger-ui.tagsSorter=alpha

Result :

answered Feb 15 '23 at 15:53

Bilal

1,254
13
14

Swagger API Operations Ordering

5 Answers5

Linked