Неполная документация Swagger для конечной точки SpringBoot с параметром MultipartFile

Question

Я использую Swagger с SprintBoot для генерации документации по конечным точкам, она прекрасно работает с одним исключением: у меня есть конечная точка POST с параметром MultipartFile. В этом случае Swagger генерирует документацию, но не примерное значение (оно пустое).

public String create(@ApiParam(value = "Record to be created", required = true, type = "json", format = "json")
        @RequestPart(name = "candidate") MyDto record,
        @ApiParam(value = "File associated to the record", required = false)
        @RequestPart(value = "file", required = false) MultipartFile file) throws Exception 

Без MultipartFile значение примера показывает JSON пример, который можно использовать. Я хотел бы иметь то же самое, когда включен дополнительный (необязательный) параметр MultipartFile.

Можно ли как-то решить эту проблему?

Answer 1

, насколько я знаю, можно добавлять документы swagger при добавлении аннотаций, например, таких:

@ApiModel(value="MyFile")
public class MyFile{

  @ApiModelProperty(value = "originalFileName", example="The original filename")
  private String getOriginalFilename;

  [...]
}

Я бы предложил расширить объект MultipartFile и добавить эти аннотации. Таким образом, вы можете добавить документацию к параметрам и вашим дополнительным параметрам.

PS MultipartFile - это интерфейс, поэтому вам нужно расширить одну из реализаций, например CommonsMultipartFile. Чем вам нужно включить в ваш проект зависимость org. apache .commons.fileupload (для FileItem).