Knife4j
前身是swagger-bootstrap-ui
,是一个为Swagger接口文档赋能的工具
关键词:OpenAPI3、Auth2.0、AfterScript、Springfox3.0、增强改善
效果(旧版):http://swagger-bootstrap-ui.xiaominfo.com/doc.html
效果(2.X版):http://knife4j.xiaominfo.com/doc.html
Gitee:https://gitee.com/xiaoym/knife4j
GitHub:https://github.com/xiaoymin/swagger-bootstrap-ui
示例:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
特性 & 优化
2.0.6是继续在上个版本中进行迭代更新,开发者使用OpenAPI2的结构可以直接修改版本号即可进行升级,springfox框架升级到2.10.5
springfox 2.10.5 版本变化:
1、spring-plugin组件升级到2.0.0,移除了guava包
2、@EnableSwagger2注解升级为@EnableSwagger2WebMvc
Maven引用:
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <!--OpenAPI2.0的开发者继续使用Knife4j 2.x系列的版本--> <version>2.0.6</version> </dependency>
1、OAuth2认证功能的支持:简化模式(implicit)、授权码模式(authorization_code)、密码模式(password)、客户端模式(client_credentials),详细规则请参考文档
2、针对@RequestBody
注解标注的请求实体类,在接口请求参数时是否必须(require
)的显示异常的问题Gitee #I1VBGB、Gitee #I1YK2Q、Gitee #I1WCMF、Gitee #I1VDSH、GitHub #277
3、针对服务端指定consumes
的情况优化,如果服务端不指定,Ui会默认根据参数类型进行适配Gitee #I1VE25
4、解决在创建Docket
对象时赋予Host
属性后,文档界面显示接口地址异常的问题Gitee #I1XYG9
5、微服务网关聚合文档时,自定义分组名称导致增强失败的问题Gi