Swagger ApiModel Value class 的 Property

Question

我正在尝试使用Swagger Play2模块为一个Play应用程序生成api文档。我们使用大量的值类来增加类型安全和代码可读性。

其中一个操作为案例类生成JSON，如下所示：

case class MyResponse(prop1: MyValueType, prop2: MyValueType)

其中MyValueType是这样一个值类：

case class MyValueType(value: String)

它被格式化为JSON，就像使用自定义＜code＞格式[T]的字符串一样。

Swagger UI生成如下示例JSON代码：

{
  "prop1": {
      "value": "string"
  },
  "prop2": {
      "value": "string"
  }
}

虽然我希望它生成这个：

{
  "prop1": "string",
  "prop2": "string"
} 

我尝试过这样的自定义注释，但似乎不起作用:

case class MyResponse(
  @ApiModelProperty(dataType="string") prop1: MyValueType, 
  @ApiModelProperty(dataType="string") prop2: MyValueType, 
)

关于如何实现这一点有什么建议吗？

Answer 1

我尝试了@ApiModelProperty（dataType=“String”）和@ApiModelProperty（dataType=“String”）。它们都不起作用。

然而，< code > @ ApiModelProperty(dataType = " Java . lang . string ")在我的例子中是有效的。

我的springfox版本：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

Answer 2

Swagger正在将您的案例类MyValueType包装在您的案例类MyResponse中。

它将忽略您的< code>dataType注释，并仍在解析< code>MyValueType

你尝试过对你的属性做更完整的注释吗？类似于:

case class MyResponse(@ApiModelProperty(
                          value = "Property 1",
                          dataType="string") prop1: MyValueType, 
                      @ApiModelProperty(
                          value = "Property 2",
                          dataType="string") prop2: MyValueType)

顺便说一句，Swagger中的数据类型不区分大小写，因此string等价于String。

Answer 3

尝试用大写的dataType="String "