knife4j 简单使用

13 篇文章 0 订阅

knife4j完全遵循了springfox-swagger中的使用方式,并在此基础上做了增强功能,如果用过Swagger,可以无缝切换到knife4j

快速开始
1、 在pom.xml中增加knife4j的相关依赖

<!--整合Knife4j-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.4</version>
</dependency>
2、 在Swagger2Config中增加一个@EnableKnife4j注解,该注解可以开启knife4j的增强功能

/**
 * Swagger2API文档的配置
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class Swagger2Config {
    
}
3、运行我们的SpringBoot应用,访问API文档地址即可查看:
http://localhost:8080/doc.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
使用 `knife4j` 可以为 Swagger 生成的 API 文档增加一些额外的功能,例如页面美化、接口测试等。下面是使用 `knife4j` 的简单步骤: 1. 在 `pom.xml` 文件添加 `knife4j-spring-boot-starter` 的依赖项: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>${knife4j.version}</version> </dependency> ``` 2. 在 Spring Boot 的启动类上添加 `@EnableKnife4j` 注解: ```java import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc; import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; @SpringBootApplication @EnableSwagger2 @EnableSwagger2WebMvc @EnableKnife4j public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 3. 在 `application.yml` 或 `application.properties` 配置 `knife4j`: ```yaml # 配置 knife4j knife4j: title: Knife4j API Doc description: Knife4j API Doc version: 1.0.0 contact: name: Contact Name url: https://www.example.com email: contact@example.com license: name: Apache License 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html ``` 4. 访问 Swagger 文档页面,此时已经增加了 `knife4j` 的功能。例如: ``` http://localhost:8080/swagger-ui.html ``` `knife4j` 还提供了丰富的配置选项,例如页面主题、接口文档展示方式等,您可以根据需要进行配置

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值