{"release":{"tag":{"name":"v2.0.7","path":"/xiaoym/knife4j/tags/v2.0.7","tree_path":"/xiaoym/knife4j/tree/v2.0.7","message":"","commit":{"id":"a192f1b6db9c1be64f4961de17c44f728ba9fa54","short_id":"a192f1b","title":"!31 3.0.1 RELEASED","title_markdown":"\u003Ca title=\"Pull Request: 3.0.1 RELEASED\" class=\"gfm gfm-pull_request\" href=\"/xiaoym/knife4j/pulls/31\"\u003E!31\u003C/a\u003E3.0.1 RELEASED","description":"Merge pull request !31 from 萧明/dev","description_markdown":"Merge pull request \u003Ca title=\"Pull Request: 3.0.1 RELEASED\" class=\"gfm gfm-pull_request\" href=\"/xiaoym/knife4j/pulls/31\"\u003E!31\u003C/a\u003Efrom 萧明/dev","message":"!31 3.0.1 RELEASED\nMerge pull request !31 from 萧明/dev","message_markdown":"\u003Ca title=\"Pull Request: 3.0.1 RELEASED\" class=\"gfm gfm-pull_request\" href=\"/xiaoym/knife4j/pulls/31\"\u003E!31\u003C/a\u003E3.0.1 RELEASED\nMerge pull request \u003Ca title=\"Pull Request: 3.0.1 RELEASED\" class=\"gfm gfm-pull_request\" href=\"/xiaoym/knife4j/pulls/31\"\u003E!31\u003C/a\u003Efrom 萧明/dev","detail_path":"/xiaoym/knife4j/commit/a192f1b6db9c1be64f4961de17c44f728ba9fa54","commits_path":"/xiaoym/knife4j/commits/a192f1b6db9c1be64f4961de17c44f728ba9fa54","tree_path":"/xiaoym/knife4j/tree/a192f1b6db9c1be64f4961de17c44f728ba9fa54","author":{"name":"萧明","email":"xiaoymin@foxmail.com","username":"xiaoym","user_path":"/xiaoym","enterprise_user_path":null,"image_path":"https://foruda.gitee.com/avatar/1676902420607731264/118100_xiaoym_1578918321.jpg!avatar30","is_gitee_user":true,"is_enterprise_user":null,"widget_url":""},"committer":{"name":"Gitee GPG Bot","email":"noreply@gitee.com","username":"gitee-bot","user_path":"/gitee-bot","enterprise_user_path":null,"image_path":"https://foruda.gitee.com/avatar/1677201213385506226/10186697_gitee-bot_1639518846.png!avatar30","is_gitee_user":true,"is_enterprise_user":null,"widget_url":""},"authored_date":"2020-11-02T10:54:10+08:00","committed_date":"2020-11-02T10:54:10+08:00","signature":null,"build_state":null},"archive_path":"/xiaoym/knife4j/repository/archive/v2.0.7","signature":null},"operating":{"edit":false,"download":true,"destroy":false,"enterprise_forbid_zip":false},"release":{"title":"Knife4j 2.0.7发布,细节优化","path":"/xiaoym/knife4j/releases/tag/v2.0.7","tag_path":"/xiaoym/knife4j/tree/v2.0.7","project_id":1872269,"created_at":"2020-11-02T10:59:59+08:00","is_prerelease":false,"description":"`Knife4j`前身是`swagger-bootstrap-ui`,是一个为Swagger接口文档赋能的工具\r\n\r\n**文档**：[https://doc.xiaominfo.com](https://doc.xiaominfo.com/)\r\n\r\n**效果(旧版)**：http://swagger-bootstrap-ui.xiaominfo.com/doc.html\r\n\r\n**效果(2.X版)**：[http://knife4j.xiaominfo.com/doc.html](http://knife4j.xiaominfo.com/doc.html)\r\n\r\n**Gitee**：https://gitee.com/xiaoym/knife4j\r\n\r\n**GitHub**：https://github.com/xiaoymin/swagger-bootstrap-ui\r\n\r\n**示例**：https://gitee.com/xiaoym/swagger-bootstrap-ui-demo\r\n\r\n## 特性 \u0026 优化\r\n\r\n1、服务端创建Docket对象时配置`globalOperationParameters`参数时,header类型不选中或丢失的问题\r\n\r\n2、如果服务端写会的json参数中包含base64的图片格式，在响应栏增加图片标签直接显示\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-6b961298ceefa5cff2e2b2374356d87d93f.png)\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-3611e3a6b050682d73b0210ec19d05976b3.png)\r\n\r\n3、springfox升级到2.10.5版本后，针对basePath会在解析时自动追加到path节点，因为以前的版本没有追加,所以会导致重复添加basePath的问题。[Gitee #I230K8](https://gitee.com/xiaoym/knife4j/issues/I230K8)、[Gitee #I23G5V](https://gitee.com/xiaoym/knife4j/issues/I23G5V)\r\n\r\n4、导出出md离线文档请求参数部分字段的设置和文档中同步[Gitee #I22UFA](https://gitee.com/xiaoym/knife4j/issues/I22UFA)\r\n\r\n5、字段参数说明支持`html`标签样式。[Gitee #I22RZ2](https://gitee.com/xiaoym/knife4j/issues/I22RZ2)\r\n\r\n示例代码：\r\n\r\n```java\r\n@ApiModelProperty(value = \"奖金名称,记住:\u003Cbr /\u003E\u003Cspan style=\\\"color:red\\\"\u003E我很重要\u003C/span\u003E\",example = \"MVP奖杯\")\r\nprivate String name;\r\n```\r\n\r\n效果图：\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-e3a7a2c712a9e57875979288924b0a3ed64.png)\r\n\r\n6、默认去除小蓝点的版本控制，开发者可以通过在服务端通过配置进行开启,详情请参考[增强文档](https://doc.xiaominfo.com/knife4j/enhance.html)。\r\n\r\n```yml\r\nknife4j:\r\n  enable: true\r\n  setting:\r\n\t#是否开启界面中对某接口的版本控制,如果开启，后端接口变化后Ui界面会存在小蓝点\r\n    enableVersion: true \r\n```\r\n\r\n7、可以通过配置重命名界面Swagger Models的命名,详情请参考[增强文档](https://doc.xiaominfo.com/knife4j/enhance.html)，例如：\r\n\r\n```yml\r\nknife4j:\r\n  enable: true\r\n  setting:\r\n    enableSwaggerModels: true\r\n    swaggerModelName: 实体类列表\r\n```\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-1ab5c027f89924fca0dbf854e6cd13dadb2.png)\r\n\r\n8、可以通过配置是否显示调试栏中的`AfterScript`功能，该属性默认为`true`,详情请参考[增强文档](https://doc.xiaominfo.com/knife4j/enhance.html)，例如：\r\n\r\n```yml\r\nknife4j:\r\n  enable: true\r\n  setting:\r\n    enableAfterScript: false\r\n```\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-66d46dc15e3a7a128566f7aca736c3bb83f.png)\r\n\r\n9、支持`@RequestMapping`注解中的`params`参数[Gitee #I22J5Q](https://gitee.com/xiaoym/knife4j/issues/I22J5Q)\r\n\r\n10、`3.0`版本不支持`Authorize`的问题[Gitee #I22WVM](https://gitee.com/xiaoym/knife4j/issues/I22WVM)\r\n\r\n11、增加局部刷新变量的按钮功能，可以通过服务端配置开启[Gitee #I22XXI](https://gitee.com/xiaoym/knife4j/issues/I22XXI)，该属性默认为`false`,详情请参考[增强文档](https://doc.xiaominfo.com/knife4j/enhance.html)，例如：\r\n\r\n```yml\r\nknife4j:\r\n  enable: true\r\n  setting:\r\n    enableReloadCacheParameter: true\r\n```\r\n\r\n![](https://oscimg.oschina.net/oscnet/up-482a2d1471f3c1f2accb19a1c1cf4f5e187.png)\r\n\r\n12、修复兼容性bug，当升级后，默认`Swagger Models`以及`文档管理`功能丢失的问题\r\n\r\n## 使用方法\r\n\r\nJava开发使用`Knife4j`目前有一些不同的版本变化，主要如下：\r\n\r\n1、如果开发者继续使用OpenAPI2的规范结构，底层框架依赖springfox2.10.5版本，那么可以考虑`Knife4j`的2.x版本\r\n\r\n```xml\r\n\u003Cdependency\u003E\r\n    \u003CgroupId\u003Ecom.github.xiaoymin\u003C/groupId\u003E\r\n    \u003CartifactId\u003Eknife4j-spring-boot-starter\u003C/artifactId\u003E\r\n    \u003C!--在引用时请在maven中央仓库搜索2.X最新版本号--\u003E\r\n    \u003Cversion\u003E2.0.7\u003C/version\u003E\r\n\u003C/dependency\u003E\r\n```\r\n\r\n2、如果开发者使用OpenAPI3的结构，底层框架依赖springfox3.0.0,可以考虑`Knife4j`的3.x版本\r\n\r\n```xml\r\n\u003Cdependency\u003E\r\n    \u003CgroupId\u003Ecom.github.xiaoymin\u003C/groupId\u003E\r\n    \u003CartifactId\u003Eknife4j-spring-boot-starter\u003C/artifactId\u003E\r\n    \u003C!--在引用时请在maven中央仓库搜索3.X最新版本号--\u003E\r\n    \u003Cversion\u003E3.0.1\u003C/version\u003E\r\n\u003C/dependency\u003E\r\n```\r\n\r\n3、如果开发者底层框架使用的是`springdoc-openapi`框架,则需要使用`Knife4j`提供的对应版本,需要注意的是该版本没有`Knife4j`提供的增强功能，是一个纯Ui。\r\n\r\n```xml\r\n\u003Cdependency\u003E\r\n    \u003CgroupId\u003Ecom.github.xiaoymin\u003C/groupId\u003E\r\n    \u003CartifactId\u003Eknife4j-springdoc-ui\u003C/artifactId\u003E\r\n    \u003C!--在引用时请在maven中央仓库搜索3.X最新版本号--\u003E\r\n    \u003Cversion\u003E3.0.1\u003C/version\u003E\r\n\u003C/dependency\u003E\r\n```\r\n","author":{"name":"萧明","username":"xiaoym","path":"/xiaoym","avatar_url":"https://foruda.gitee.com/avatar/1676902420607731264/118100_xiaoym_1578918321.jpg!avatar30"},"attach_files":[],"zip_download_url":"/xiaoym/knife4j/releases/tag/v2.0.7.zip","tar_download_url":"/xiaoym/knife4j/releases/tag/v2.0.7.tar.gz"}}}