揚鞭JAXRS提供POST請求類描述

Question

隨着揚鞭我可以

@ApiOperation(value = "save a user", response = User.class) 
@POST 
public Response saveUser(String message){...} 

然後生成JSON響應結構如例如

User { 
    id (integer, optional), 
    email (string, optional) 
} 

如何指定結構註釋響應對象不改變saveUser方法的方法參數類型的POST消息？

我要尋找類似：

@ApiOperation(value = "save a user", response = User.class, request = User.class) 

有沒有辦法這樣做呢？

Answer 1

是的，有一種方法可以做到這一點。您應該查看annotating your models的文檔。在你的榜樣，我會標註模型爲：

@ApiModel(value = "An individual model details") 
User { 

    @ApiModelProperty(value = "description", required=true) 
    id, 
    @ApiModelProperty(value = "description", required=true) 
    email 
} 

那麼你的資源會是這樣的：

@POST 
@ApiOperation(value = "short description", notes = "long description", response = User.class) 
Response create(@ApiParam(value = "description", required = true) String message) { 
    //do stuff 
} 

注意傳入消息的ApiParam註解，而ApiOperation註釋描述了即將退市的車型。