Springdoc中表示表单数据和返回字节数组时出现问题

Question

我有以下一段代码，

@PostMapping(value = "/create/{userId}", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<Object> saveFile(
        @Parameter(description = "ID of the user") @PathVariable(value = "userId") final String userId,
        @Parameter(description = "Avatar of the user", content = @Content(mediaType = MediaType.APPLICATION_OCTET_STREAM_VALUE)) @RequestParam(value = "avatar", required = true) final MultipartFile file
) {
    ...
}

@GetMapping(value = "/get", produces = MediaType.IMAGE_PNG_VALUE)
@ApiResponse(responseCode = "200", description = "OK", content = {@Content(array = @ArraySchema(schema = @Schema(implementation = Byte.class)))})
public ResponseEntity<byte[]> getFile() {
    ...
}

我如何达到预期的结果？预期结果来自Springfox。

Answer 1

上周我也面临同样的问题。我的解决方案是通过SpringDocUtils将返回类型byte-Array替换为String：

import org.springframework.context.annotation.Configuration;
import org.springdoc.core.SpringDocUtils;

@Configuration
public class OpenApiConfiguration {

    static {
        SpringDocUtils.getConfig()
                        .replaceWithClass(byte[].class, String.class);
    }
}

对我来说，这种方法的优点是每个字节[]都将被字符串表示所取代，因此不需要通过@apisresponse进行相应的显式注释。但我认为这取决于用例。

Answer 2

对于文件格式，规格上的not type字节。您应该发送类型：字符串，格式：二进制。

• https://swagger.io/docs/specification/describing-request-body/file-upload/

因此，post方法的requestBody是正确的。

要描述POST方法上字节数组类型的返回，可以添加以下描述：

@ApiResponse（content=@content（schema=@schema（type=“string”，format=“binary”））