SpringBoot整合knife4j(快速入门超详细版)
在Spring Boot项目中整合Knife4j,首先需要引入Knife4j的依赖,然后配置Swagger。以下是具体步骤和示例代码:
- 在
pom.xml
中添加Knife4j的依赖:
<dependencies>
<!-- 引入knife4j依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<!-- 如果需要使用Knife4j提供的UI主题,还需要引入以下依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-ui</artifactId>
<version>3.0.3</version>
</dependency>
</dependencies>
- 在
application.properties
或application.yml
中配置Knife4j:
# 配置Knife4j的相关属性,例如使用自定义的扫描包
knife4j:
# 开启Knife4j提供的UI主题
enable: true
# 自定义扫描的包路径
base-package: com.example.demo.controller
# 接口文档的标题
title: MyProject API Docs
- 在Spring Boot启动类上添加
@EnableKnife4j
注解启用Knife4j:
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@EnableKnife4j // 启用Knife4j
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
- 使用Swagger注解标注你的Controller和方法:
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/demo")
@Api(tags = "示例接口")
public class DemoController {
@GetMapping("/greet")
@ApiOperation("问候接口")
public String greet() {
return "Hello, Knife4j!";
}
}
完成以上步骤后,你可以通过访问http://<host>:<port>/doc.html
来查看API文档,例如,如果你的应用运行在localhost
的8080
端口,你可以在浏览器中输入http://localhost:8080/doc.html
来查看API文档。
评论已关闭