scala - 如何在我的 Play/Scala 项目中为 Swagger 的 @ApiOperation 指定 json 响应

Question

我正在使用 swagger 来记录我的 Play-Scala 应用程序。

我的 Controller 如下:

@Api(value = "/people")
class PersonController {
  import JsonFormats._

  @ApiOperation(response = ?????, responseContainer = "Array", httpMethod = "GET")
  def showPeople(...) = Action {
    // Code here..to get persons of type List[Person]

    val json: JsObject = Json.obj("people" -> persons)
    Ok(json)
  }
}

我的 JsonFormats.scala 如下:

object JsonFormats {
  implicit val personFormat = new Format[Person] {
    def writes(person: Person): JsValue = {
      Json.obj(
        "fName" -> person.name.fName,
        "lName" -> person.name.lName,
        "age" -> person.age)

  }
}

我的模型类如下

case class Person(name: Name, age: String) {
  gender: String
}

case class Name {
  fName: String,
  lName: String,
}

问题 :在我的 Controller 中 @ApiOperation 的响应参数中指定什么，因此它在 swagger-ui 中按预期格式(如下所示)显示 json 响应结构。

{ 
    "people":[
                {
                    "fName":"",
                    "lName":"",
                    "age":""
                }
              ]
}

Answer 1

这是一个示例:

   @ApiOperation(
    value = "Get a content type by its name",
    notes = "Returns a content type",
    response = classOf[models.ContentType],
    httpMethod = "GET"
  )
  @ApiResponses(Array(
    new ApiResponse(code = 404, message = "Content Type not found")
  ))

在这种情况下，models.ContentType 是案例类。

干杯