前言
Swagger2（基于openApi3）已經(jīng)在17年停止維護(hù)了，取而代之的是 sagger3（基于openApi3），而國(guó)內(nèi)幾乎沒(méi)有 sagger3使用的文檔，百度搜出來(lái)的大部分都是swagger2的使用，這篇文章將介紹如何在 java 中使用 openApi3（swagger3）。
一、swagger 3 的使用
Open API
OpenApi是業(yè)界真正的 api 文檔標(biāo)準(zhǔn)，其是由 Swagger 來(lái)維護(hù)的，并被linux列為api標(biāo)準(zhǔn)，從而成為行業(yè)標(biāo)準(zhǔn)。
Swagger
swagger 是一個(gè) api 文檔維護(hù)組織，后來(lái)成為了 Open API 標(biāo)準(zhǔn)的主要定義者，現(xiàn)在最新的版本為17年發(fā)布的 Swagger3（Open Api3）。國(guó)內(nèi)絕大部分人還在用過(guò)時(shí)的swagger2（17年停止維護(hù)并更名為swagger3）swagger2的包名為 io.swagger，而swagger3的包名為 io.swagger.core.v3。
SpringFox
SpringFox是 spring 社區(qū)維護(hù)的一個(gè)項(xiàng)目（非官方），幫助使用者將 swagger2 集成到 Spring 中。常常用于 Spring 中幫助開(kāi)發(fā)者生成文檔，并可以輕松的在spring boot中使用。目前已經(jīng)支持 OpenAPI3 標(biāo)準(zhǔn)。
升級(jí)到 OpenAPI3（java 中 swagger1.x 對(duì)應(yīng) OpenAPI2、swagger 2.x對(duì)應(yīng)OpenAPI3）官方文檔
3.0 相關(guān)特性
- 支持 Spring 5，Webflux（僅請(qǐng)求映射支持，尚不支持功能端點(diǎn)）、Spring Integration
- 補(bǔ)充官方在 spring boot 的自動(dòng)裝配 pringfox-boot-starter 以后可以直接依賴一個(gè) dependency
- 與2.0更好的規(guī)范兼容性
- 支持OpenApi 3.0.3
- 輕依賴 spring-plugin，swagger-core
- 現(xiàn)有的swagger2批注將繼續(xù)有效并豐富開(kāi)放式API 3.0規(guī)范
常用注解說(shuō)明
@Api：用在請(qǐng)求的類上，表示對(duì)類的說(shuō)明
tags: 說(shuō)明該類的作用，可以在UI界面上看到的注解
value: 該參數(shù)沒(méi)什么意義，在UI界面上也看到，所以不需要配置
@ApiOperation：用在請(qǐng)求的方法上，說(shuō)明方法的用途、作用
value: 說(shuō)明方法的用途、作用
notes: 方法的備注說(shuō)明
@ApiImplicitParams：用在請(qǐng)求的方法上，表示一組參數(shù)說(shuō)明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面
name：參數(shù)名
value：參數(shù)的漢字說(shuō)明、解釋
required：參數(shù)是否必須傳
paramType：參數(shù)放在哪個(gè)地方
· header --> 請(qǐng)求參數(shù)的獲?。篅RequestHeader
· query --> 請(qǐng)求參數(shù)的獲?。篅RequestParam
· path（用于restful接口）--> 請(qǐng)求參數(shù)的獲取：@PathVariable
· body（不常用）
· form（不常用）
dataType：參數(shù)類型，默認(rèn)String，其它值dataType="Integer"
defaultValue：參數(shù)的默認(rèn)值
@ApiResponses：用在請(qǐng)求的方法上，表示一組響應(yīng)
@ApiResponse：用在@ApiResponses中，一般用于表達(dá)一個(gè)錯(cuò)誤的響應(yīng)信息
code：數(shù)字，例如400
message：信息，例如"請(qǐng)求參數(shù)沒(méi)填好"
response：拋出異常的類
@ApiModel：用于響應(yīng)類上，表示一個(gè)返回響應(yīng)數(shù)據(jù)的信息，一般用在post創(chuàng)建的時(shí)候，使用@RequestBody這樣的場(chǎng)景，請(qǐng)求參數(shù)無(wú)法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
@ApiModelProperty：用在屬性上，描述響應(yīng)類的屬性
name：屬性名
value：屬性的漢字說(shuō)明、解釋
@ApiParam 用于 Controller 中方法的參數(shù)說(shuō)明，放在方法簽名當(dāng)中
value：參數(shù)說(shuō)明
required：是否必填
@ApiIgnore：使用該注解忽略這個(gè)API
二、在項(xiàng)目中的使用
- 1、引入pom包，這里同時(shí)引入增強(qiáng)包knife4j
<!-- Swagger3 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
- 2、application.yml 添加配置，放在spring目錄下面：
Springfox使用的路徑匹配是基于AntPathMatcher的，而Spring Boot 2.6.X使用的是PathPatternMatcher。
# ========================================================================
# 啟動(dòng)報(bào)錯(cuò)需要修改以下mvc配置 Failed to start bean 'documentationPluginsBootstrapper'
spring:
mvc:
pathmatch:
matching-strategy: ant_path_matcher
# ========================================================================
- 3、升級(jí)spring boot到2.7.0，使用swagger 3.0報(bào)錯(cuò)
升級(jí)spring boot到2.7.0，項(xiàng)目啟動(dòng)報(bào)錯(cuò)，項(xiàng)目使用swagger 3.0 ,具體版本是knife4j-spring-boot-starter的3.0.3，查找解決方案，都說(shuō)修改配置文件（但是修改配置后仍然無(wú)效）或者新增配置類，過(guò)濾空情況，但是仍然還是解決了很長(zhǎng)時(shí)間。報(bào)錯(cuò)信息：Caused by: java.lang.NullPointerException: Cannot invoke “org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()” because “this.condition” is null
Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2022-06-04 12:30:54.079 [main] ERROR org.springframework.boot.SpringApplication - Application run failed
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException: Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()" because "this.condition" is null
at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:181)
at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:54)
at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:356)
at java.base/java.lang.Iterable.forEach(Iterable.java:75)
at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:155)
at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:123)
at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:935)
at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:586)
at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147)
at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:734)
at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:408)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:308)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1306)
at org.springframework.boot.SpringApplication.run(SpringApplication.java:1295)
at com.cloud.user.UserApplication.main(UserApplication.java:41)
Caused by: java.lang.NullPointerException: Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()" because "this.condition" is null
at springfox.documentation.spring.web.WebMvcPatternsRequestConditionWrapper.getPatterns(WebMvcPatternsRequestConditionWrapper.java:56)
at springfox.documentation.RequestHandler.sortedPaths(RequestHandler.java:113)
at springfox.documentation.spi.service.contexts.Orderings.lambda$byPatternsCondition$3(Orderings.java:89)
at java.base/java.util.Comparator.lambda$comparing$77a9974f$1(Comparator.java:473)
at java.base/java.util.TimSort.countRunAndMakeAscending(TimSort.java:355)
at java.base/java.util.TimSort.sort(TimSort.java:234)
at java.base/java.util.Arrays.sort(Arrays.java:1307)
at java.base/java.util.ArrayList.sort(ArrayList.java:1721)
at java.base/java.util.stream.SortedOps$RefSortingSink.end(SortedOps.java:392)
at java.base/java.util.stream.Sink$ChainedReference.end(Sink.java:258)
at java.base/java.util.stream.Sink$ChainedReference.end(Sink.java:258)
at java.base/java.util.stream.Sink$ChainedReference.end(Sink.java:258)
at java.base/java.util.stream.Sink$ChainedReference.end(Sink.java:258)
at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:510)
at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:499)
at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:921)
at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:682)
at springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider.requestHandlers(WebMvcRequestHandlerProvider.java:81)
at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197)
at java.base/java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1625)
at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:509)
at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:499)
at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:921)
at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
at java.base/java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:682)
at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.withDefaults(AbstractDocumentationPluginsBootstrapper.java:107)
at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.buildContext(AbstractDocumentationPluginsBootstrapper.java:91)
at springfox.documentation.spring.web.plugins.AbstractDocumentationPluginsBootstrapper.bootstrapDocumentationPlugins(AbstractDocumentationPluginsBootstrapper.java:82)
at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:100)
at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178)
... 14 common frames omitted
解決方案
- 新增一個(gè)配置類，注意配置類不能放到swagger的配置類下，測(cè)試無(wú)效。配置Bean可以放在啟動(dòng)類下或者重新新增一個(gè)配置Bean，代碼如下:
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
import java.lang.reflect.Field;
import java.util.List;
import java.util.stream.Collectors;
@Slf4j
@Configuration
public class BeanPostProcessorConfig {
@Bean
public BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
return new BeanPostProcessor() {
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
}
return bean;
}
private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
List<T> copy = mappings.stream()
.filter(mapping -> mapping.getPatternParser() == null)
.collect(Collectors.toList());
mappings.clear();
mappings.addAll(copy);
}
@SuppressWarnings("unchecked")
private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
try {
Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
field.setAccessible(true);
return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
} catch (IllegalArgumentException | IllegalAccessException e) {
throw new IllegalStateException(e);
}
}
};
}
}
- 4、添加自定義配置類：
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.context.request.async.DeferredResult;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* 文檔訪問(wèn)地址：http://ip:port/swagger-ui/index.html
* 添加Knife4j可以導(dǎo)出導(dǎo)出離線文檔，訪問(wèn)地址：http://ip:port/doc.html
*
*/
@Configuration
@EnableKnife4j
@EnableOpenApi
@ConditionalOnProperty(value = "spring.profiles.active", havingValue = "dev")
//@Profile({"dev","test"})
public class SwaggerConfiguration {
@Bean
public Docket createRestApis() {
return new Docket(DocumentationType.OAS_30)
.enable(true)//是否啟用：注意生產(chǎn)環(huán)境需要關(guān)閉
.groupName("spring-boot-2.7.3")
.genericModelSubstitutes(DeferredResult.class)
.useDefaultResponseMessages(false)
.forCodeGeneration(true)
.ignoredParameterTypes(CookieValue.class)
.apiInfo(apiInfo())
.select()
//以下攔截配置可以三選一，根據(jù)需要進(jìn)行添加
.apis(RequestHandlerSelectors.basePackage("com.qi.study.springboot.controller"))
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("使用swagger生成的接口文檔")
.description("開(kāi)發(fā)測(cè)試")
// 服務(wù)條款URL
.termsOfServiceUrl("https://www.baidu.com/")
// 作者信息
.contact(new Contact("qihh", "https://www.baidu.com/", "qihh@136.com"))
.version("0.0.1")
.build();
}
}
- 5、添加攔截器配置，放行相關(guān)目錄
import com.kfang.web.price.manager.interceptor.AuthorizationInterceptor;
import com.kfang.web.price.manager.interceptor.ContextInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import javax.annotation.Resource;
@Configuration
public class InterceptorConfiguration implements WebMvcConfigurer {
@Resource
private Environment env;
@Resource
private AuthorizationInterceptor authorizationInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
String[] swaggerExcludePathPatterns = {"/doc.html","/swagger**/**","/swagger-resources/**","/webjars/**","/v3/**"};
registry.addInterceptor(new ContextInterceptor()).addPathPatterns("/**");
if("dev".equals(env.getProperty("spring.profiles.active"))){
}else{
swaggerExcludePathPatterns = new String[0];
}
registry.addInterceptor(authorizationInterceptor)
.excludePathPatterns("/user/logout")
.excludePathPatterns("/user/login")
.excludePathPatterns(swaggerExcludePathPatterns)
.addPathPatterns("/**").order(-1);
}
}
- 6、測(cè)試demo
@Api(tags = "用戶",value = "用戶")
@RestController
@RequestMapping(value = "/user", produces = {"application/json;charset=UTF-8"})
public class UserController {
@ApiOperation("添加")
@PostMapping("/add")
@ApiResponses({
@ApiResponse(message = "添加", code = 200, response = UserVO.class)
})
public UserVO add(@RequestBody @Valid UserAddRequest userAddRequest) {
// 將數(shù)據(jù)寫到數(shù)據(jù)庫(kù)
UserVO userVO = new UserVO();
BeanUtils.copyProperties(userAddRequest, userVO);
userVO.setId(1L);
userVO.setCreateTime(LocalDateTime.now());
userVO.setUpdateTime(LocalDateTime.now());
return userVO;
}
@ApiOperation("修改")
@PostMapping("/edit")
@ApiResponses({
@ApiResponse(message = "修改", code = 200, response = UserVO.class)
})
public UserVO edit(@RequestBody @Valid UserEditRequest userEditRequest) {
// 修改數(shù)據(jù)庫(kù)的數(shù)據(jù)
UserVO userVO = new UserVO();
BeanUtils.copyProperties(userEditRequest, userVO);
userVO.setUpdateTime(LocalDateTime.now());
return userVO;
}
@ApiOperation("查找")
@GetMapping("/find")
@ApiResponses({
@ApiResponse(message = "查找", code = 200, response = UserQueryRequest.class)
})
public List<UserVO> find(UserQueryRequest userQueryRequest) {
return new ArrayList<>();
}
@ApiOperation("刪除")
@PostMapping("/delete")
public void delete(Long id) {
// 將數(shù)據(jù)庫(kù)數(shù)據(jù)刪除
}
@PostMapping(value = "/fileUpload")
@ApiOperation(value = "文件上傳")
@ApiResponses({
@ApiResponse(message = "文件上傳", code = 200, response = AliyunUploadResult.class)
})
public String uploadFile(@RequestPart("file") MultipartFile file) {
AliyunUploadRequest uploadRequest = new AliyunUploadRequest(file);
AliyunUploadResult result = aliyunOss.fileUpload(uploadRequest);
return successInfo(result);
}
@PostMapping(value = "/importDataDetail")
@ApiOperation(value = "導(dǎo)入Excel源數(shù)據(jù)明細(xì)")
@ApiResponses({
@ApiResponse(message = "導(dǎo)入Excel源數(shù)據(jù)明細(xì)出參成功", code = 200, response = Boolean.class)
})
public String importDataDetail(@RequestPart("file") MultipartFile file,
@RequestParam("cityId") String cityId) {
}
}
三，啟動(dòng)測(cè)試
-
1、訪問(wèn)swagger-ui頁(yè)面：http://localhost:8080/swagger-ui/index.html
?
-
2、訪問(wèn)knife4j-ui頁(yè)面：http://localhost:8080/doc.html
knife4j是springfox-swagger的增強(qiáng)UI實(shí)現(xiàn)，為Java開(kāi)發(fā)者在使用Swagger的時(shí)候，提供了簡(jiǎn)潔、強(qiáng)大的接口文檔體驗(yàn)。引入pom包，并開(kāi)啟@EnableKnife4j注解就可以使用。
?
- 3、設(shè)置安全密碼登錄配置：
server.port=8081
knife4j.enable=true
knife4j.basic.enable=true
knife4j.basic.username=admin
knife4j.basic.password=admin
knife4j.setting.language=zh-CN
登錄界面：
四、@RequestParam和@RequestPart的區(qū)別
@RequestPart
- @RequestPart這個(gè)注解用在multipart/form-data表單提交請(qǐng)求的方法上。
- 支持的請(qǐng)求方法的方式MultipartFile，屬于Spring的MultipartResolver類。這個(gè)請(qǐng)求是通過(guò)http協(xié)議傳輸?shù)?/li>
@RequestParam
- @RequestParam支持’application/json’，也同樣支持multipart/form-data請(qǐng)求
區(qū)別
當(dāng)請(qǐng)求方法的請(qǐng)求參數(shù)類型不是String 或 MultipartFile / Part時(shí)，而是復(fù)雜的請(qǐng)求域時(shí)，@RequestParam 依賴Converter or PropertyEditor進(jìn)行數(shù)據(jù)解析， RequestPart參考 ‘Content-Type’ header，依賴HttpMessageConverters 進(jìn)行數(shù)據(jù)解析
當(dāng)請(qǐng)求為multipart/form-data時(shí)，@RequestParam只能接收String類型的name-value值，@RequestPart可以接收復(fù)雜的請(qǐng)求域（像json、xml）；@RequestParam 依賴Converter or PropertyEditor進(jìn)行數(shù)據(jù)解析， @RequestPart參考'Content-Type' header，依賴HttpMessageConverters進(jìn)行數(shù)據(jù)解析
前臺(tái)請(qǐng)求：
jsonData為Person對(duì)象的json字符串
uploadFile為上傳的圖片
?文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-504416.html
后臺(tái)接收：文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-504416.html
- 1、@RequestPart可以將jsonData的json數(shù)據(jù)轉(zhuǎn)換為Person對(duì)象
@RequestMapping("jsonDataAndUploadFile")
@ResponseBody
public String jsonDataAndUploadFile(@RequestPart("uploadFile") MultiPartFile uploadFile,
@RequestPart("jsonData") Person person) {
StringBuilder sb = new StringBuilder();
sb.append(uploadFile.getOriginalFilename()).append(";;;"));
return person.toString() + ":::" + sb.toString();
}
- 2、@RequestParam對(duì)于jsonData的json數(shù)據(jù)只能用String字符串來(lái)接收
@RequestMapping("jsonDataAndUploadFile")
@ResponseBody
public String jsonDataAndUploadFile(@RequestPart("uploadFile") MultiPartFile uploadFile,
@RequestParam("josnData") String jsonData) {
StringBuilder sb = new StringBuilder();
sb.append(uploadFile.getOriginalFilename()).append(";;;"));
return person.toString() + ":::" + sb.toString();
}到了這里，關(guān)于SpringBoot——2.7.3版本整合Swagger3的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
