Menu
I want to sort my Schemas generated for my Entity classes, DTO classes in Springdoc UI.
I am able to sort the tags and operations using the below configuration in yml file but my schemas are not in the sorted order.
springdoc:
swagger-ui:
disable-swagger-default-url: true
tags-sorter: alpha
operations-sorter: alpha
doc-expansion: none
How could I sort my schemas.
Thanks.
339
Although the terms once referred to the same thing, they can no longer be used interchangeably…even though some people still do. In 2021, OpenAPI refers to the industry-standard specification for RESTful API design. Swagger refers to a set of SmartBear tools.
How can I define multiple OpenAPI definitions in one Spring Boot project? You can define your own groups of API based on the combination of: API paths and packages to scan. Each group should have a unique groupName .
springdoc-openapi works by examining an application at runtime to infer API semantics based on spring configurations, class structure and various annotations. Automatically generates documentation in JSON/YAML and HTML format APIs. This documentation can be completed by comments using swagger-api annotations.
You can have full control of the schemas order using OpenApiCustomiser. If you are interested on the sorting on the swagger-ui, not on the server side, then you can log a feature request on the swagger-ui project instead. Sorry, something went wrong. Perhaps it would be nice to make this sorting the default as well.
It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort () to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger UI. Boolean=false.
For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file: . 3. Springdoc-openapi Modules 3.1. General overview
From lowest to highest precedence: 1 The swagger-config.yaml in the project root directory, if it exists, is baked into the application 2 configuration object passed as an argument to Swagger UI ( SwaggerUI ( { ... })) 3 configuration document fetched from a specified configUrl 4 configuration items passed as key/value pairs in the URL query string
You can have full control of the schemas order using OpenApiCustomiser. This is a sample code that you can customize using Comparators, depending on the sorting logic you want:
@Bean
public OpenApiCustomiser sortSchemasAlphabetically() {
return openApi -> {
Map<String, Schema> schemas = openApi.getComponents().getSchemas();
openApi.getComponents().setSchemas(new TreeMap<>(schemas));
};
}
If you are interested on the sorting on the swagger-ui, not on the server side, then you can log a feature request on the swagger-ui project.
108
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
