swagger-ui升级版

swagger-ui升级版

介绍

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升级版

全局参数设置

swagger-ui升级版

*可以设置header等信息

离线文档导出

Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\Pdf)

swagger-ui升级版

依赖引入

swagger-ui升级版

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

在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用
swagger-ui升级版

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

Spring Cloud微服务架构

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

swagger-ui升级版

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

swagger-ui升级版

上一篇:swagger升级版 knife4j的使用


下一篇:knife4j入门