java - 是否可以配置 spring-openapi 以在 v3 api-docs 中生成可预测的订单输出？

Question

在为 springdoc OpenAPI v3 api-docs 生成输出时，任何细微的变化都会导致在生成的 v3 api 文档中产生完全不同的顺序。

保持这个顺序可预测会很方便，特别是在使用.yaml输出时进行调试。因此，如果有人知道订购此产品的方法，我将不胜感激。

Answer 1

springdoc-openapi 基于 io.swagger.v3.oas.models.OpenAPI 对象。

Paths 元素是 LinkedHashMap 类型，使用此类型时会保留顺序。@Parameters如果您使用注解或注解按特定顺序声明所有参数，@Operation则将保留该顺序。

您在 swagger-ui 方面也有一些属性。例如：

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

对于调试/测试/比较结果，您可以使用 JSONAssert 库进行比较。

最后，您可以使用 OpenAPICustomiser 对 OpenAPI 对象的所有元素进行排序。