开始 springBoot 整合 swagger3.0,上传文件接口文件上传的button不出来
springboot版本:2.2.6.RELEASE
swagger版本:3.0.0
knife4j版本: 3.0.3
maven引入swagger包
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
配置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;
}
上传文件接口,@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));
}
百度试了好几种方法都不行。折腾了大半天,终于测试可行了,赶紧做个记录~