java - 如何在 Swagger-ui 中为正文输入流生成文件选择器

Question

您好，我有以下 jaxrs 条目

@PUT()
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_OCTET_STREAM)
@ApiOperation(value = "Bla bla.")
@Path("secure/flappy")
public Response testput(
        @ApiParam(value = "pwet",type = "file",format = "binary", required = true) InputStream certificate) throws Throwable {
    try (InputStream stream = certificate) {
        //Consume stream
        return Response.ok().build();
    }
}

以及为该条目生成的 swagger-ui 页面

我想知道如何记录我的参数，以便在 swagger-ui 中仅获取一个作为文件选择器呈现的参数。

Answer 1

@sdc:你是对的，我必须使用多部分表单数据来在 Swagger-ui 中获取工作文件选择器。我还必须使用 @ApiImplicitParam 才能使其正常工作。

@PUT()
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.MULTIPART_FORM_DATA)
@ApiOperation(value = "Bla bla.")
@Path("secure/flappy")
@ApiImplicitParams({
    @ApiImplicitParam(name = "file", value = "bla bla.", required = true, dataType = "java.io.File", paramType = "form")
})
public Response testput(@ApiParam(hidden = true) @FormDataParam("file") final  InputStream certificate
) throws Throwable {
    //TODO do something
    return Response.ok().build();
}