springboot项目整合配置knife4j

一、在pom文件中加入依赖

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.9</version>
        </dependency>

二、在spring boot的配置文件(application.properties)中加入以下命令

knife4j.enable=true

三、添加一个配置类


import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
你可以按照以下步骤在Spring Boot整合Knife4j(原Swagger): 1. 在您的Spring Boot项目中添加Knife4j的依赖。在您的pom.xml文件中添加以下依赖: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency> ``` 2. 在您的Spring Boot配置文件(application.properties或application.yml)中配置Knife4j。 对于application.properties,添加以下配置: ```properties # 配置Knife4j的扫描包路径 springfox.documentation.swagger.v2.path=/swagger # 配置Knife4j的UI页面标题 knife4j.title=Your API Documentation # 配置Knife4j的UI页面描述 knife4j.description=API Documentation for Your Project # 配置Knife4j的UI页面联系人信息 knife4j.contact.name=Your Name knife4j.contact.url=Your Website knife4j.contact.email=Your Email ``` 对于application.yml,添加以下配置: ```yaml springfox: documentation: swagger: v2: path: /swagger knife4j: title: Your API Documentation description: API Documentation for Your Project contact: name: Your Name url: Your Website email: Your Email ``` 3. 在您的控制器类或方法上使用Swagger注解来生成API文档。例如: ```java @RestController @RequestMapping("/api") @Api(tags = "API") public class ApiController { @ApiOperation("获取用户信息") @GetMapping("/user/{id}") public User getUser(@PathVariable Long id) { // 实现逻辑 } } ``` 4. 运行您的Spring Boot应用程序,并访问"http://localhost:8080/swagger"(根据您的实际端口和上下文路径进行调整)即可查看生成的API文档。 注意:这里的示例是基于Swagger 2.x版本的Knife4j,如果您使用的是Swagger 3.x版本,配置可能会有所不同。请根据您使用的Knife4j版本进行相应的配置。 希望这个简单的步骤能够帮助您整合Knife4j到您的Spring Boot项目中。如有其他问题,请随时向我提问!

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值