Jdk17 +Springboot3.1.3 集成 OpenApi+Knife4j
之前大量的去找openApi集成knife4j的资料发现有很多的问题,现在这个是我整理了网上很多集成教程修改的,基于Jdk17+Springboot3.1.3 +knife4j-openapi3-jakarta-spring-boot-starter
在pom中加入如下配置
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.2</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.28</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId> knife4j-openapi3-jakarta-spring-boot-starter </artifactId> <version>4.3.0</version> </dependency> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency>
配置yml文件
# spring-doc 接口文档
springdoc:
api-docs:
enabled: true
group-configs:
- group: 'default'
paths-to-match: '/**'
packages-to-scan: com.changan.afterservicecommon
default-flat-param-object: true
# knife4j的增强配置,不需要增强可以不配
knife4j:
enable: true
setting:
language: zh_cn
packages-to-scan为你的项目包名称如我的项目包路径为com.changan.afterservicecommon
创建config配置类
package com.changan.afterservicecommon.config;
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @author : cosmos
* @since : 2023-12-05 13:49:16
* @description : openapi 界面配置
* @param :
* @return : null
*/
@Configuration
public class OpenApiConfig {
@Bean
public OpenAPI openAPI() {
return new OpenAPI()
.info(new Info().title("Knife4j And OpenApi 3")
.description("Knife4j OpenApi 3 example application")
.version