如何在 Springdoc OpenAPI 3.0 中控制标签顺序?
How do I control tag order in Springdoc OpenAPI 3.0?
我正在从 Springfox 3.0 切换到 OpenAPI 3.0 + Springdoc-openapi。
在 Springfox 中,标签顺序是按字母顺序排列的,但在 Springdoc 的 Swagger UI 中,顺序似乎是随机的。
如何控制 UI 上的标签顺序?
我更喜欢我选择的顺序,但也可以按标签名称的字母顺序排序。
@Tag(name = MY_CONTROLLER_TAG_NAME, description = MY_CONTROLLER_TAG_DESC)
public class MyController {
所需订单:
- 分页端点
- 用户访问权限
- 标记
- 标记 - 管理员
- 用户管理
- 用户管理 - 管理员
实际订单:
- 用户访问权限
- 标记
- 分页端点
- 标记 - 管理员
- 用户管理 - 管理员
- 用户管理
POM 依赖项:
<springdoc-openapi.version>1.6.4</springdoc-openapi.version>
...
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>${springdoc-openapi.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-security</artifactId>
<version>${springdoc-openapi.version}</version>
</dependency>
Application.yml:
springdoc:
show-actuator: ${SWAGGER_ENABLED:true}
swagger-ui:
doc-expansion: none
api-docs:
enabled: ${SWAGGER_ENABLED:true}
model-converters:
pageable-converter:
enabled: true
试试:
springdoc.swagger-ui.tagsSorter: alpha
springdoc.writer-with-order-by-keys: true
我正在从 Springfox 3.0 切换到 OpenAPI 3.0 + Springdoc-openapi。
在 Springfox 中,标签顺序是按字母顺序排列的,但在 Springdoc 的 Swagger UI 中,顺序似乎是随机的。
如何控制 UI 上的标签顺序? 我更喜欢我选择的顺序,但也可以按标签名称的字母顺序排序。
@Tag(name = MY_CONTROLLER_TAG_NAME, description = MY_CONTROLLER_TAG_DESC)
public class MyController {
所需订单:
- 分页端点
- 用户访问权限
- 标记
- 标记 - 管理员
- 用户管理
- 用户管理 - 管理员
实际订单:
- 用户访问权限
- 标记
- 分页端点
- 标记 - 管理员
- 用户管理 - 管理员
- 用户管理
POM 依赖项:
<springdoc-openapi.version>1.6.4</springdoc-openapi.version>
...
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>${springdoc-openapi.version}</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-security</artifactId>
<version>${springdoc-openapi.version}</version>
</dependency>
Application.yml:
springdoc:
show-actuator: ${SWAGGER_ENABLED:true}
swagger-ui:
doc-expansion: none
api-docs:
enabled: ${SWAGGER_ENABLED:true}
model-converters:
pageable-converter:
enabled: true
试试:
springdoc.swagger-ui.tagsSorter: alpha
springdoc.writer-with-order-by-keys: true