基于springboot3基本使用knife4j-openapi3-jakarta-spring-boot-starter
要在Spring Boot 3中使用knife4j-openapi3-jakarta-spring-boot-starter
,首先需要在项目的pom.xml
中添加以下依赖:
<dependencies>
<!-- 添加Knife4j的OpenAPI 3.0依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>最新版本号</version>
</dependency>
<!-- 其他依赖 -->
</dependencies>
接下来,在application.properties
或application.yml
中配置Knife4j的基本属性,例如:
knife4j:
enable: true
# 其他可选配置
然后,在Spring Boot的启动类上添加@EnableKnife4jOpenApi
注解启用Knife4j:
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4jOpenApi;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableKnife4jOpenApi // 启用Knife4j
public class MySpringBootApplication {
public static void main(String[] args) {
SpringApplication.run(MySpringBootApplication.class, args);
}
}
最后,你可以通过访问http://<host>:<port>/swagger-ui/index.html
来查看API文档,或者使用Knife4j提供的更丰富的界面。
请确保替换<host>
和<port>
为你的服务器地址和端口号,并使用最新版本号替换<最新版本号>
。
评论已关闭