北京卓天下网站建设公司,网站做seo收录,代理网页是干什么的,深圳网站设计哪家强knife4j
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
knife4j的前身是swagger-bootstrap-ui#xff0c;为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采…knife4j
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
knife4j的前身是swagger-bootstrap-ui为了契合微服务的架构发展,由于原来swagger-bootstrap-ui采用的是后端Java代码前端Ui混合打包的方式,在微服务架构下显的很臃肿,因此项目正式更名为knife4j。
目前项目主要的模块如下 此示例根据官方文档介绍演示。
核心功能
该UI增强包主要包括两大核心功能文档说明 和 在线调试 文档说明根据Swagger的规范说明详细列出接口文档的说明包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息使用swagger-bootstrap-ui能根据该文档说明对该接口的使用情况一目了然。 在线调试提供在线接口联调的强大功能自动解析当前接口参数,同时包含表单验证调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息帮助开发者在线调试而不必通过其他测试工具测试接口是否正确,简介、强大。
UI增强
同时swagger-bootstrap-ui在满足以上功能的同时还提供了文档的增强功能这些功能是官方swagger-ui所没有的每一个增强的功能都是贴合实际,考虑到开发者的实际开发需要,是比不可少的功能主要包括 个性化配置通过个性化ui配置项可自定义UI的相关显示信息 离线文档根据标准规范生成的在线markdown离线文档开发者可以进行拷贝生成markdown接口文档通过其他第三方markdown转换工具转换成html或pdf这样也可以放弃swagger2markdown组件 接口排序自1.8.5后ui支持了接口排序功能例如一个注册功能主要包含了多个步骤,可以根据swagger-bootstrap-ui提供的接口排序规则实现接口的排序step化接口操作方便其他开发者进行接口对接
快速开始
相信使用过springboot的人大都知道和用过swaggerknife4j的使用方法和swagger几乎一模一样没有什么学习成本不同的是展示的接口UI文档更加友好和人性化。下面开始演示一个集成项目首先来看pom文件依赖 只引入一个knife4j的starter即可不用其它依赖。springboot的配置文件和启动类不用做任何特殊配置使用knife4j需要一个swagger的配置类这个配置类和以前使用swagger几乎是一样的 可以看到内容上没什么变化唯一的变化是类注解需要比原来的swagger多加一个 EnableSwaggerBootstrapUi。这样knife4j的所有配置都完成了
软件版本增强注解说明knife4j2.0.0EnableSwaggerBootstrapUi knife4j2.0.1EnableKnife4j后续版本不会再更改
启动项目可以访问地址
http://localhost:8080/doc.html?plus1
来看一下效果 配置简单接口
下面来配置一个简单的接口查看文档的展示效果。首先来看接口的通用返回结果模型定义 注意要在文档上面展示需要使用图中的注解。这个通用结果的具体数据是一个泛型类型。下面我们定义一个具体的业务数据模型 通过上面两个的定义接口的返回类型就搞定了下面来看接口 这个接口类中分为几个部分需要注意第一是类上面的Api注解描述了整个类的接口分类含义。还有一个是每个接口上面的 ApiImplicitParams 注解定义了接口的所有参数。还有ApiResponses注解定义了返回时所有状态码所代表的的含义最后是ApiOperation注解描述了单个接口本身的功能。
定义接口完成后我们来重启项目查看文档的效果 首页上面有一些变化左侧列表多了HelloController类的整体描述栏目我们点开这个栏目可以看到类中定义的所有接口 点击这个接口看到右侧非常详细的接口文档 上图中展示的是接口地址接口类型接口描述和详细的入参描述下面的相应状态展示了我们定义的两种状态类型还有接口的回参也非常详细的列了出来 文字描述类型数据结构类型都有还有响应示例可以说非常清晰了。个人认为这种展示效果比原来的swagger要友好很多。
右侧还有调试功能可以直接使用来测试接口 在左侧的文档管理中还可以设置全局参数支持类似jwt的带权限的测试 对文档还可以进行个性化设置 说明
上面简单介绍和演示了knife4j这个starter不仅支持swagger-bootstrap-ui原始的swagger-ui还是可以使用的: 有些更加喜欢原始风格的同学可以看这个页面。另外swagger有很多注解可以使文档展示的信息更加完善和友好大家可以自行尝试和学习。
坑处 有个比较坑的地方可能guava的版本是2.0以下会报错com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google
解决方法是引入高版本
dependencygroupIdcom.google.guava/groupIdartifactIdguava/artifactIdversion20.0/version
/dependency
