Openapi swagger 文档生成引用

Question

我在一个带注释的对象中有几个枚举，如：

@Schema(description = "Request description")
case class Request(
   @Schema(description = "Enum1 description")
   field2: Enum1,
  
   @Schema(description = "Enum2 description")
   field2: Enum2
)

其中枚举定义为：

sealed trait Enum1 extends EnumEntry
object Enum1 extends Enum[Enum1] {
   case object Value1 extends Enum1
   case object Value2 extends Enum1
}

sealed trait Enum2 extends EnumEntry
object Enum2 extends Enum[Enum2] {
   case object Value3 extends Enum2
   case object Value4 extends Enum2
}

使用Openapi3，我可以生成一个swagger文档。我的问题是，Enum1和Enum2，翻译方式不同，如：

"field1":{
    "enum":["Value1","Value2"],
    "type":"string"
},

"field2":{
  "$ref":"#/components/schemas/Enum2"
}

/* ... */

"Enum2":{
  "description":"Enum2 description",
  "type":"object"
}

我希望< code>Enum2与< code>Enum1一样被记录，因此具有实际的枚举值。有什么方法可以强制这样做，或者解释为什么会这样？两个枚举基本上与示例中的相同。

Answer 1

在我的情况下，我设法通过将实现参数添加到@Schema注释中来解决它。基于这个和这个：

@Schema(description = "Request description")
case class Request(
   @Schema(
     implementation = classOf[Enum1],
     description = "Enum1 description"
   )
   field1: Enum1,
)