Springboot 整合 Knife4j (API文档生成工具)
要在Spring Boot项目中整合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>
</dependencies>
- 在Spring Boot的application.properties或application.yml配置文件中,可以设置Knife4j的一些基本属性,例如文档标题、描述等:
knife4j:
basic:
enable: true
contact-name: John Doe
contact-url: http://www.example.com
contact-email: test@example.com
title: MyProject API Docs
description: MyProject API Documentation
- 在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
public class MyProjectApplication {
public static void main(String[] args) {
SpringApplication.run(MyProjectApplication.class, args);
}
}
- 在Controller层使用Knife4j提供的注解来描述API:
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!";
}
}
完成以上步骤后,你的Spring Boot项目就可以运行并且集成了Knife4j,可以通过http://<host>:<port>/doc.html
访问API文档页面。
评论已关闭