夸张的文档:对响应内容的描述

我有一个简单的fileupload rest api,它将上传的文件存储在数据库中,并返回数据库中上传文件的unque引用(uuid)。

我使用swagger生成api文档,它的工作方式很有魅力,但我找不到添加描述文本来描述响应内容的方法。

这是我休息的签名:

@POST
@Path("/upload")
@Consumes(ExtendedMediaType.MULTIPART_FORM_DATA)
@ApiOperation(
        value = "Save an image",
        notes = "Save the uploaded image to database.",
        response = String.class)
@ApiResponses(value = {
        @ApiResponse(code = 200, message = "The uploaded image has been saved.", response = String.class),
        @ApiResponse(code = 500, message = "Error while trying to resize the image.<p>Internal error code: 2103", response = a.b.ErrorInfo.class)})
@Override
public String uploadImage(
        @ApiParam(value = "file to upload", required = true) @FormDataParam("file") final InputStream inputStream,
        @ApiParam(value = "details of the uploaded file", required = true) @FormDataParam("file") final FormDataContentDisposition fileDetail) {

    //return UUID.randomUUID().toString();
}

为了描述响应字符串的内容,我想在api文档中添加以下信息:

"The unique id of the uploaded image."

我查过了 ApiResponses 文档,但我没有找到与此主题相关的任何内容。

我可以把这些信息放在 ApiResponse 但我不确定这个解决方案是否正确。