Swagger Tipo di dati Modello in ImplicitParam con Play Framework

Question

Sto cercando di utilizzare Swagger per documentare la mia API REST. A seguito di questa example, ho annotare l'endpoint REST in questo modo:

case class CreateItemRequest(title: String, body: String) 

@ApiOperation(value = "Create a new item", httpMethod = "POST", response = classOf[Item]) 
@ApiImplicitParams(Array(new ApiImplicitParam(dataType = "CreateItemRequest", paramType = "body", name = "body", required = true, allowMultiple = false, value = "The item object to create"))) 
def create(
      @ApiParam(value = "Hash of the user", required = true) 
      @QueryParam("userhash") userhash: String 
     ) 

E mi aspettavo di ottenere "Modello" come ma ottengo solo il "CreateItemRequest" String come tipo di dati. Non le proprietà della classe case CreateItemRequest.

Saluti, Daniel

Answer 1

cercare di annotare i vostri modelli con le annotazioni spavalderia pure, come illustrato di seguito:

https://github.com/swagger-api/swagger-core/blob/master/samples/scala-play2/app/models/Pet.scala

vostra annotazione ApiModel (name = "CreateItemRequest") abbinare l'annotazione @ApiImplicitParam (dataType = "CreateItemRequest")

Cheers, Johannes

Answer 2

Provare a utilizzare questa annotazione @JsonAutoDetect e @JsonIgnoreProperties(ignoreUnknown = true) prima della classe e quindi aggiungere @JsonPropety per ogni proprietà che si desidera mostrare.

Assicurarsi che nella definizione del percorso si chiama il proprio metodo come:

GET url controllers.foo.YourMethod(param: type) 

Altro esempio here.

Spero che questo ti possa aiutare.

Answer 3

È necessario utilizzare lo spazio dei nomi completo nell'attributo dataType. Ad esempio: @ApiImplicitParam(dataType = "org.test.CreateItemRequest")