如何从ReDoc隐藏枚举常量？

问题描述

我正在使用OpenAPI v3和springdoc，并希望从ReDoc隐藏枚举常量：

请注意，我不想隐藏属性status。我希望其常量不会出现在API文档中。我该怎么做？

解决方法

您可以使用swagger-ui设置：这不会隐藏生成的OpenAPI文档中的值：

springdoc:
  swagger-ui:
    defaultModelRendering: example

如果您需要隐藏所有值并要求用户填充字符串，则只需在枚举的顶部添加@Schema声明即可：

@Schema(type = "string")
public enum StatusEnum {

}