上一篇文章介绍了Swagger2默认UI的接入方式,但是UI实在太丑,而且布局也很难用,这里介绍一个相对漂亮点的UI——knife4j。
knife4j是基于swagger2开发的,是swagger-ui的替代方案。
【SpringBoot|接入Swagger2(2) —— knife4j】???????官网地址:https://doc.xiaominfo.com
1、接入
pom添加依赖即可,如下:
com.github.xiaoymin
knife4j-spring-boot-starter
3.0.3
2、配置
需要对knife4j中的资源进行地址映射,如下:
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableWebMvc
@EnableSwagger2
public class Swagger2Config implements WebMvcConfigurer {/**
* knife4j的资源映射
* @param registry
*/
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}
注:如果SpringBoot版本低于2.6.0,上面这段代码就可以省了
3、查看
接口文档地址:
http://localhost:端口/接口路径/doc.html
页面截图如下:
文章图片
最简单的接入,就是这样,是不是相当简单
推荐阅读
- #|Spring分布式缓存
- springboot|Springboot 启动流程源码解析(广播器,以及内嵌tomcat启动)
- ★推荐一款适用于SpringBoot项目的轻量级HTTP客户端框架
- Springboot docker jenkins 自动化部署并上传镜像
- SpringBoot加email服务,你说有没有搞头()
- springboot
- SpringBoot+RabbitMQ 实现 RPC 调用
- springboot|springboot项目配置多数据库连接
- SpringBoot|SpringBoot+Vue从零开始做网站8-全局异常处理和使用mybatis-plus分页插件