swagger 导出离线文档_感觉Swagger功能不够强大?knife4j这款神器了解一下

来源:https://gitee.com/xiaoym/knife4j

1.概览

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧、轻量、并且功能强悍!

knife4j的前身是swagger-bootstrap-ui,为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码+前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j。

更名后主要专注的方面

  • 前后端Java代码以及前端Ui模块进行分离,在微服务架构下使用更加灵活
  • 提供专注于Swagger的增强解决方案,不同于只是改善增强前端Ui部分
84b1f63b1e373a6cfb00165dc8e0be2a.png

2.项目模块

目前主要的模块包括:

3.功能特性

简洁

基于左右菜单式的布局方式,是更符合国人的操作习惯吧,文档更清晰…

个性化配置

个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能…

增强

接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能…

4.业务场景

不使用增强功能,纯粹换一个swagger的前端皮肤

不使用增强功能,纯粹换一个swagger的前端皮肤。这种情况是最简单的,你项目结构下无需变更

可以直接引用swagger-bootstrap-ui的最后一个版本1.9.6或者使用knife4j-spring-ui

老版本引用

    com.github.xiaoymin    swagger-bootstrap-ui    1.9.6

新版本引用

    com.github.xiaoymin    knife4j-spring-ui    ${lastVersion}

Spring Boot项目单体架构使用增强功能

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用

    com.github.xiaoymin    knife4j-spring-boot-starter    ${knife4j.version}

该包会引用所有的knife4j提供的资源,包括前端Ui的jar包

Spring Cloud微服务架构

在Spring Cloud的微服务架构下,每个微服务其实并不需要引入前端的Ui资源,因此在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter

    com.github.xiaoymin    knife4j-micro-spring-boot-starter    ${knife4j.version}

在网关聚合文档服务下,可以再把前端的ui资源引入

    com.github.xiaoymin    knife4j-spring-boot-starter    ${knife4j.version}

5.界面效果

在线预览

http://knife4j.xiaominfo.com/doc.html

Authorize

465f121cf64054fbaf420579cd75eeea.png

Swagger Models

8dab45d9eddb360f2bc31aa2aa727869.png

全局参数设置

fbd5ccf0b26435f547f4d973bd869490.png

离线文档下载

7663a9ebcdd9a3c756e94f8f959b65be.png

其他个性化设置

9ba4b60f4b420f298a1f5f786ab3f1a1.png

关键字搜索

f484d5ea02ee1286a911ad38dc101358.png

6.总结

非常不错的一个开源项目,Gitee上已经有近2k的star,感兴趣的朋友不妨试试!

Githubhttps://github.com/xiaoymin/swagger-bootstrap-ui码云https://gitee.com/xiaoym/knife4j

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值