springBoot2.x+swagger3.0+knife4j+shiro上传文件接口出现的问题

  1. 开始 springBoot 整合 swagger3.0,上传文件接口文件上传的button不出来

springboot版本:2.2.6.RELEASE

swagger版本:3.0.0

knife4j版本: 3.0.3

  1. maven引入swagger包

    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-boot-starter</artifactId>
       <version>3.0.0</version>
    </dependency>
  1. 配置swagger文件,里面有header里的公用Authorization鉴权参数

@Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.OAS_30)
                .enable(swaggerProperties.getEnable())
                //配置网站的基本信息
                .apiInfo(apiInfo())
                .host(swaggerProperties.getTryHost())
//                .globalOperationParameters(pars)
                .select()
                //指定接口的位置
                .apis(RequestHandlerSelectors.basePackage("com.maliang.api.module.controller"))
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(swaggerProperties.getApplicationDescription())
                .description(swaggerProperties.getApplicationDescription())
                .version(swaggerProperties.getApplicationVersion())
                .build();
    }


    //header里放入Authorization参数
    private List<SecurityScheme> securitySchemes() {
        List<SecurityScheme> securitySchemes = new ArrayList<>();
        securitySchemes.add(new ApiKey("Authorization", "Authorization", "header"));
        return securitySchemes;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
        return securityContexts;
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
        return securityReferences;
    }
  1. 上传文件接口,@RequestPart换成@RequestPart即可,我下面的例子由于是集成了shiro,所以取文件的方式是从转换后的request里取的, @RequestPart在我这的作用只是为页面上提供了个文件上传的button入口。转换后的request一样能取到。功能不影响

@PostMapping(value = "/uploadImage")
    @ApiOperation(value = "上传文件到本地",notes="接口请求格式为multipart/form-data格式")
 public void uploadImage(HttpServletRequest request, HttpServletResponse response
        @RequestPart(value = "file", required = false) MultipartFile file
    ){
        MultipartResolver resolver1 = new CommonsMultipartResolver(request.getSession().getServletContext());
        MultipartHttpServletRequest multipartRequest1 = resolver1.resolveMultipart(request);
        MultipartFile file1 = multipartRequest1.getFile("file");
        String filePath = fileUploadService.createLocalFile(file1);
        writeResponse(response, Response.result(filePath));
    }
2. 整合了knife4j v3.0.3
<dependency>
          <groupId>com.github.xiaoymin</groupId>
          <artifactId>knife4j-spring-boot-starter</artifactId>
          <version>3.0.3</version>
      </dependency>

毕竟knife4j的界面比swagger看上去舒服太多,但是上传文件又出现问题。form-data格式下又没上传文件的按钮,经过摸索,修改文件上传接口如下即可,加了@ApiImplicitParam注解,里面设置dataType和dataTypeClass

@PostMapping(value = "/uploadImage")
    @ApiOperation(value = "上传文件到本地",notes="接口请求格式为multipart/form-data格式")
    @ApiImplicitParam(name = "file",value = "上传文件到本地",required = true,dataType="MultipartFile",dataTypeClass = MultipartFile.class,paramType = "query")
    public void uploadImage(HttpServletRequest request, HttpServletResponse response
 ){
        MultipartResolver resolver1 = new CommonsMultipartResolver(request.getSession().getServletContext());
        MultipartHttpServletRequest multipartRequest1 = resolver1.resolveMultipart(request);
        MultipartFile file1 = multipartRequest1.getFile("file");
        String filePath = fileUploadService.createLocalFile(file1);
        writeResponse(response, Response.result(filePath));
    }

百度试了好几种方法都不行。折腾了大半天,终于测试可行了,赶紧做个记录~

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

weixin_40546390

你的鼓励是我最大的动力~~~

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值