java - 如何配置 Swagger UI、Jersey 和文件上传？

Question

我有一个 Jersey 服务，其文件上传方法看起来像这样(简化):

@POST
@Path("/{observationId : [a-zA-Z0-9_]+}/files")
@Produces({ MediaType.APPLICATION_JSON})
@Consumes(MediaType.MULTIPART_FORM_DATA)
@ApiOperation(
    value = "Add a file to an observation",
    notes = "Adds a file to an observation and returns a JSON representation of the uploaded file.",
    response = ObservationMediaFile.class
)
@ApiResponses({
    @ApiResponse(code = 404, message = "Observation not found. Invalid observation ID."),
    @ApiResponse(code = 406, message= "The media type of the uploaded file is not supported. Currently supported types are 'images/*' where '*' can be 'jpeg', 'gif', 'png' or 'tiff',")
})
public RestResponse<ObservationMediaFile> addFileToObservation(
    @PathParam("observationId") Long observationId,
    @FormDataParam("file") InputStream is,
    @FormDataParam("file") FormDataContentDisposition fileDetail,
    @FormDataParam("fileBodyPart") FormDataBodyPart body
){

    MediaType type = body.getMediaType();

    //Validate the media type of the uploaded file...
    if( /* validate it is an image */    ){
        throw new NotAcceptableException("Not an image. Get out.");
    }

    //do something with the content of the file
    try{
        byte[] bytes = IOUtils.toByteArray(is);
    }catch(IOException e){}

    //return response...
}

它有效，我可以使用 Chrome 中的 Postman 扩展成功测试它。

但是，Swagger 看到 2 个名为“file”的参数。它似乎以某种方式理解 InputStream 参数和 FormDataContentDisposition 参数实际上是同一 file 参数的两部分，但它没有看到对于 FormDataBodyPart 参数。

这是参数的 Swagger JSON:

parameters: [
{
  name: "observationId",
  required: true,
  type: "integer",
  format: "int64",
  paramType: "path",
  allowMultiple: false
},
{
  name: "file",
  required: false,
  type: "File",
  paramType: "body",
  allowMultiple: false
},
{
  name: "fileBodyPart",
  required: false,
  type: "FormDataBodyPart",
  paramType: "form",
  allowMultiple: false
}]

因此，Swagger UI 会生成一个文件选择器字段，以及一个用于 FormDataBodyPart 参数的额外文本字段:

因此，当我选择一个文件并在 Swagger UI 中提交表单时，我最终读取的是 InputStream 中文本字段的内容，而不是上传文件的内容。如果我将文本字段留空，我会得到文件的名称。

如何指示 Swagger 忽略 FormDataBodyPart 参数？

或者，作为变通方法，如何在没有 FormDataBodyPart 对象的情况下获取上传文件的媒体类型？

我使用 Jersey 2.7 和 swagger-jersey2-jaxrs_2.10 版本 1.3.4。

Answer 1

为 Jersey 创建一个 swagger 过滤器，然后将参数标记为内部参数或您要过滤的其他字符串。此示例中也显示了这一点:

https://github.com/wordnik/swagger-core/blob/master/samples/java-jaxrs/src/main/java/com/wordnik/swagger/sample/util/ApiAuthorizationFilterImpl.java

你的服务方法会有这个参数注解

@ApiParam(access = "internal") @FormDataParam("file") FormDataBodyPart body,

您的过滤器将像这样查找它:

public boolean isParamAllowed(Parameter parameter, Operation operation, ApiDescription api,
        Map<String, List<String>> params, Map<String, String> cookies, Map<String, List<String>> headers) {
    if ((parameter.paramAccess().isDefined() && parameter.paramAccess().get().equals("internal")))
        return false;
    else
        return true;
}

为 Jersey 注册你的 swagger 过滤器，然后它不会返回该字段并且 swagger-ui 不会显示它，这将解决你的上传问题。

<init-param>
      <param-name>swagger.filter</param-name>
      <param-value>your.company.package.ApiAuthorizationFilterImpl</param-value>
    </init-param>