告别 swagger-ui ,我选择了这款神器!

强烈推介IDEA2020.2破解激活,IntelliJ IDEA 注册码,2020.2 IDEA 激活码
关注我们,设为星标,每天7:30不见不散,架构路上与您共享 

回复"架构师"获取资源


一、介绍

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

告别 swagger-ui ,我选择了这款神器!


二、开源仓库


  • Github

https://github.com/xiaoymin/swagger-bootstrap-ui
  • 码云

https://gitee.com/xiaoym/knife4j

三、功能特性


  • 简洁

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

  • 个性化配置

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

  • 增强

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

四、功能预览


  • 在线预览

http://knife4j.xiaominfo.com/doc.html
  • 选择不同接口

告别 swagger-ui ,我选择了这款神器!

  • Authorize

告别 swagger-ui ,我选择了这款神器!

  • swagger实体

包含了swagger实体的相关信息

告别 swagger-ui ,我选择了这款神器!

  • swagger全局设置

全局参数设置

告别 swagger-ui ,我选择了这款神器!

告别 swagger-ui ,我选择了这款神器!

  • 离线文档导出

Knife4j提供导出4种格式的离线文档(HtmlMarkdownWordPdf)

告别 swagger-ui ,我选择了这款神器!

  • 个性化设置

告别 swagger-ui ,我选择了这款神器!

  • api文档

告别 swagger-ui ,我选择了这款神器!

告别 swagger-ui ,我选择了这款神器!

  • 搜索功能

告别 swagger-ui ,我选择了这款神器!

五、使用简介

  • 项目结构


告别 swagger-ui ,我选择了这款神器!

  • 目前主要的模块

目前主要的模块包括:模块名称说明:knife4j为Java MVC框架集成Swagger的增强解决方案knife4j-admin云端Swagger接口文档注册管理中心,集成gateway网关对任意微服务文档进行组合集成knife4j-extensionchrome浏览器的增强swagger接口文档ui,快速渲染swagger资源knife4j-service为swagger服务的一系列接口服务程序knife4j-frontknife4j-spring-ui的纯前端静态版本,用于集成非Java语言使用swagger-bootstrap-uiknife4j的前身,最后发布版本是1.9.6
  • 单纯皮肤增强

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

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

老版本引用


<dependency>    
  <groupId>com.github.xiaoymin</groupId>    
  <artifactId>swagger-bootstrap-ui</artifactId>    
  <version>1.9.6</version>
</dependency>


新版本引用


<dependency>    
  <groupId>com.github.xiaoymin</groupId>    
  <artifactId>knife4j-spring-ui</artifactId>    
  <version>${lastVersion}</version>
</dependency>



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

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


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


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

  • Spring Cloud微服务架构

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


<dependency>    
  <groupId>com.github.xiaoymin</groupId>    
  <artifactId>knife4j-micro-spring-boot-starter</artifactId>    
  <version>${knife4j.version}</version>
</dependency>


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


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



六、总结


针对knife4j的总结,无非就是牛逼来形容,切实的解决了swagger ui不够友好的问题,而且还可以集成到其他语言的api项目中,真真切切的需要感谢开发作者提供了这么好的工具供我们使用,小伙伴是不是心动了,赶紧去试试吧!enjoy it!


文章来源:http://suo.im/5zfEzX


告别 swagger-ui ,我选择了这款神器!


到此文章就结束了。如果今天的文章对你在进阶架构师的路上有新的启发和进步,欢迎转发给更多人。欢迎加入架构师社区技术交流群,众多大咖带你进阶架构师,在后台回复“加群”即可入群。




第9期书已发出,中奖者注意查收




这些年小编给你分享过的干货

1.SpringBoot物流管理项目,拿去学习吧(附源码)

2.ERP系统,自带进销存+财务+生产功能,拿来即用(附源码)

3.带工作流的SpringBoot后台管理项目快速开发(附源码)
4.最好的OA系统,拿来即用,非常方便(附源码)

5.SpringBoot+Vue完整的外卖系统,手机端和后台管理,附源码!

6.SpringBoot+Vue 可视化拖拽编辑的大屏项目(附源码)

告别 swagger-ui ,我选择了这款神器!

转发在看就是最大的支持❤️

本文原创,作者:架构君,其版权均为Java架构师必看所有。如需转载,请注明出处:https://javajgs.com/archives/24464

发表评论