Swagger UI 导致 spring-resources 对文件和 json-object 的 Multipart-FormData 请求失败

Question

我在我的项目中使用 1.4.3 版本的 spring-boot。该项目提供了一些 REST-endpoints 并使用 springfox-swagger 2.6.1 生成 api-documentation。这几乎适用于我的所有请求，我可以成功尝试端点。

但是，这会停止处理 multipart-formdata 请求，其中包含一个 MultipartFile 和一个 json-object。问题类似于以下问题：

JHipster, spring rest service with MultiPart and JSON, swagger/curl error

我让它以这种方式工作，但对我来说，将 json-object 更改为请求参数不是一个有效的解决方案，因为它可能有大小（在尝试使用更大的 json-object 我收到一个错误提示，header 太大了）。

示例代码和错误信息如下：

端点：

@RequestMapping(path = "/", produces = { MediaType.APPLICATION_JSON_UTF8_VALUE },
  consumes = { MediaType.MULTIPART_FORM_DATA_VALUE }, method = RequestMethod.PUT)
@ResponseStatus(code = HttpStatus.CREATED)
public void createApproval(@RequestPart(required = true) @Valid @NotNull @NotBlank MultipartFile file,
  @RequestPart(required = true) MyClass json, HttpServletRequest request, HttpServletResponse response)

这会生成一个 swagger API，如下所示：

parameter - value              - description - parameter type - data type
file      - (upload file)      - file        - formData       - file
json      - string-value-filed - json        - formData       - undefined

使用有效数据执行此操作会产生以下错误：

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/octet-stream' not supported
at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters(AbstractMessageConverterMethodArgumentResolver.java:237)
at org.springframework.web.servlet.mvc.method.annotation.RequestPartMethodArgumentResolver.resolveArgument(RequestPartMethodArgumentResolver.java:127)
at org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:121)
at org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:160)
at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:129)
at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:116)
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:827)
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:738)
at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:963)
at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:897)
at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)
at org.springframework.web.servlet.FrameworkServlet.doPut(FrameworkServlet.java:883)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:651)
at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:729)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:230)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.boot.web.filter.ApplicationContextHeaderFilter.doFilterInternal(ApplicationContextHeaderFilter.java:55)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.boot.actuate.trace.WebRequestTraceFilter.doFilterInternal(WebRequestTraceFilter.java:105)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:99)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.web.filter.HttpPutFormContentFilter.doFilterInternal(HttpPutFormContentFilter.java:89)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.web.filter.HiddenHttpMethodFilter.doFilterInternal(HiddenHttpMethodFilter.java:77)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:197)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.springframework.boot.actuate.autoconfigure.MetricsFilter.doFilterInternal(MetricsFilter.java:106)
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:192)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:165)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:198)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:108)
at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:472)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:140)
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:79)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:87)
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:349)
at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:784)
at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)
at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:802)
at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1410)
at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
at java.lang.Thread.run(Thread.java:745)

我也为它写了一个测试，效果很好：

final MockHttpServletRequestBuilder saveRequestBuilder = MockMvcRequestBuilders.fileUpload(baseUrl).file(mockFile)
    .file(jsonFile).contentType(contentType);
saveRequestBuilder.with(new RequestPostProcessor() {
  @Override
  public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request) {
    request.setMethod("PUT");
    return request;
  }
});
mockMvc.perform(saveRequestBuilder).andExpect(status().isCreated()).andDo( and so on...

我还尝试使用@ApiImplicitParam 进行一些更改。他们中的大多数人没有改变任何东西。使用以下更改，我得到了一个不同的 API，但是随后出现错误告诉我 json-object 不存在。

@ApiImplicitParam(name = "json", value = "the json object", required = true,
  dataType = "MyClass", paramType = "body")

那么，有谁知道如何在 swagger-ui-doc 期间让它发挥作用吗？

预先感谢您的帮助！

Answer 1

没关系，我刚刚找到了解决方案。看起来，我已经在我的问题中链接了它。

我将 json 参数切换为一个简单的字符串并手动将其转换为我的 class 工作正常。因此，链接问题中的解决方案在这里也可以正常工作。

所以简短的经验教训：

Spring-Swagger-Combination 在将 json-input 转换为对象的多部分请求中存在一些问题。解决方法是使用简单的字符串并自行转换。我希望他们将来能使它发挥作用。

除了链接的解决方案之外：它不必是 RequestParam，RequestPart 也可以正常工作。

Answer 2

@RequestMapping(值=“/api/fileupload”,方法=RequestMethod.POST) public ResponseEntity uploadFile(@RequestPart("file") MultipartFile 上传文件) {

尝试将您的控制器与上述匹配。很可能与@RequestPart 注释有关。

Swagger UI 导致 spring-resources 对文件和 json-object 的 Multipart-FormData 请求失败

Swagger UI causes failure in Multipart-FormData request from spring-resources with file and json-object

java

rest

spring

multipartform-data

swagger