文件下載及圖片預(yù)覽

目前SwaggerBootstrapUi支持的響應(yīng)類型如下：

特別需要注意的是：不管是文件下載或者是需要圖片預(yù)覽,都需要在接口中指定接口的produces,否則不能達到預(yù)期效果,接口的produces可參考上面表格中列出項.

關(guān)于文件下載的支持

SwaggerBootstrapUi在1.8.9版本中添加了application/octet-stream下載類型的支持,并在1.9.0版本中完善,只需要配置相應(yīng)接口的produces,即可在doc.html頁面中查看效果，如下圖：

點擊下載文件即可下載當前接口響應(yīng)的二進制流.示例代碼可參考Api190Controller.java

特別說明,需要指定相應(yīng)的produces

@ApiOperation(value = "下載測試-有參數(shù)+請求頭版",position = 3)
@GetMapping(value = "/downloadFileAndParam2",produces = "application/octet-stream")
public void postRequest3AndParam(@RequestHeader(value = "uud") String uud,@RequestParam(value = "name") String name, HttpServletRequest request, HttpServletResponse response){
    logger.info("header:{}",uud);
    download(name,response);
}

關(guān)于圖片預(yù)覽的支持

圖片預(yù)覽一般用在驗證碼等場景中,很多時候,需要直接展示出驗證碼的情況，如下圖：

驗證碼預(yù)覽的后端代碼可參考ImageController.java

特別說明,需要指定相應(yīng)的produces

@Api(value = "圖片預(yù)覽",tags = "圖片預(yù)覽")
@RestController
@RequestMapping("/api/image")
public class ImageController {


    @GetMapping(value = "/preview",produces = "image/jpeg")
    public void preview(HttpServletRequest request, HttpServletResponse response) throws IOException {
        //more....
    }
}