API文档之Knife4j的踩坑注意事项

本文介绍了如何在项目中轻松集成Knife4j,无需重复引入Springfox依赖。步骤包括添加Knife4j依赖、配置启用(@EnableKnife4j)或通过application.yml设置,特别提醒配置文件中需包含`knife4j.setting`选项以避免常见问题。
摘要由CSDN通过智能技术生成

Knife4j完全遵循了Swagger 的使用方式,所以可以无缝切换。
第一步,在pom.xml文件中添加 Knife4j的依赖。
在这里插入图片描述
不需要再引入Swagger所需的springfox-boot-starter了,因为Knife4的starter里面已经加入过了。
在这里插入图片描述第二步,创建一个Java配置类(例如 Knife4JConfig.java),并使用@EnableKnife4j注解启用Knife4j.
或者不创建Java配置类,通过在 application.yml文件中设置属性来达到相同的目的。
注意:采坑提示,配置中至少需要有一个knife4j.setting选项。比如说:
在这里插入图片描述

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Magic-API 是基于 Spring Boot 的一款快速开发 RESTful API 的框架,而 Knife4j 是一个 Swagger UI 增强工具,可以优化 Swagger 的显示效果和交互体验。将 Knife4j 整合到 Magic-API 项目中,可以让 API 文档的展示效果更加美观和易用。 下面是整合的步骤: 1. 在 pom.xml 文件中添加 knife4j 依赖: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>${knife4j.version}</version> <scope>compile</scope> </dependency> ``` 其中,`${knife4j.version}` 是 Knife4j 的版本号。 2. 在 Magic-API 的配置类中添加 Knife4j 的配置: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.magic.api.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Magic-API") .description("基于 Spring Boot 的快速开发 RESTful API 框架") .version("1.0") .build(); } @Bean public Knife4jSpringConfiguration knife4jSpringConfiguration() { return new Knife4jSpringConfiguration(); } } ``` 其中,`Knife4jSpringConfiguration` 是 Knife4j 的配置类,需要在 Magic-API 的配置类中进行注册。 3. 启动 Magic-API 项目,访问 `http://localhost:8080/doc.html`,即可看到 Knife4j 的 UI 界面。 以上就是整合 Knife4j 到 Magic-API 框架中的步骤,希望对您有所帮助。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值