update doc 5.0

doc/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+## 5.0.0
+
+[5.0 Upgrade Guide - 5.0升级指南](./zh_CN/快速入门/5.0升级指南.md)
+
+- Comprehensive refactoring for user experience.
+- New: support api tag, which can be used for favorites.
+- New: Runtime environment variable management. Supporting Java and Golang.
+- New: Customizable replacement rules for unknown strings in api URLs.
+- New: Import and export functionality for apis (Markdown/OpenAPI/Postman/Apifox).
+
+
+- 全面重构，优化使用体验
+- 新增：接口标记支持，可作为收藏，亦支持过滤
+- 新增：运行环境变量管理，支持Java和Golang
+- 新增：扫描接口URL中的未知字符串支持自定义替换规则
+- 新增：接口导入导出（Markdown/OpenAPI/Postman/Apifox)
+
+
 ## 4.0.0
 
 [4.0 Upgrade Guide - 4.0升级指南](./zh_CN/快速入门/4.0升级指南.md)
@@ -24,7 +42,7 @@
 - [工具箱](zh_CN/核心功能/工具箱.md)
 - [命令中心](zh_CN/核心功能/命令中心.md)
 - [Git识别](zh_CN/核心功能/Git识别.md)
-- [Jvm参数管理](zh_CN/核心功能/Jvm参数管理.md)
+- [Jvm参数管理](zh_CN/核心功能/运行参数管理)
 
 ## 3.4.1
 

doc/bak/README.zh_CN2.md

@@ -360,9 +360,9 @@ if (statusCode != 200) {
 
 ### 插件扩展
 RESTKit从`2.0.1`版本开始提供了扩展点:
-- `io.github.newhoo.restkit.restful.ep.RestfulResolverProvider` 自定义扫描restful接口。
+- `io.github.newhoo.restkit.open.ep.RestfulResolverProvider` 自定义扫描restful接口。
 - `io.github.newhoo.restkit.restful.ep.LanguageResolverProvider` 自定义语言相关的操作，具体参考源码说明。
-- `io.github.newhoo.restkit.restful.ep.RestClientProvider` 自定义请求协议，从`2.0.3`开始支持。
+- `io.github.newhoo.restkit.open.ep.RestClientProvider` 自定义请求协议，从`2.0.3`开始支持。
 
 使用示例：
 

doc/en/README.md

@@ -372,9 +372,9 @@ if (statusCode != 200) {
 ### Plugin Extension
 RESTKit provided extension points from version `2.0.1`. It's very useful.
 
-- `io.github.newhoo.restkit.restful.ep.RestfulResolverProvider` you can scan restful apis for other framework.
+- `io.github.newhoo.restkit.open.ep.RestfulResolverProvider` you can scan restful apis for other framework.
 - `io.github.newhoo.restkit.restful.ep.LanguageResolverProvider` operation for special language
-- `io.github.newhoo.restkit.restful.ep.RestClientProvider` support custom request protocol from `2.0.3`.
+- `io.github.newhoo.restkit.open.ep.RestClientProvider` support custom request protocol from `2.0.3`.
 
 For example: 
 

doc/zh_CN/快速入门/4.0升级指南.md

@@ -39,15 +39,15 @@
 
 - 在安装了Java插件的IDE中可使用，如IDEA/Android Studio
 - 源自插件 <a href="https://plugins.jetbrains.com/plugin/13204-jvm-parameter">Jvm Parameter</a>，如果已经安装，需卸载，数据兼容。
-- 文档: [Jvm参数管理](../核心功能/Jvm参数管理.md)
+- 文档: [Jvm参数管理](../核心功能/运行参数管理.md)
 
 ### 7、计划添加外部插件配置管理
 
 - 有空就搞
 
 ## 三、升级
 
-通过jetbrains IDE（`233.6+`）安装/升级插件到4.0.0版本。安装后需重启IDE。
+通过jetbrains IDE（`2021.3+`）安装/升级插件到4.x版本。安装后需重启IDE。
 
 ## 四、订阅
 
@@ -74,4 +74,4 @@ IDE：Help -> Register
 
 ## 五、其他说明
 
-3.0之后的源码选择性开放，如有插件开发的问题（不限于技术问题），可以在GitHub提问或者发邮件给我。
+4.0之后的最新核心源码会开放，但涉及订阅功能部分将隐藏。如有插件开发的问题（不限于技术问题），可以在GitHub提问或者发邮件给我。

doc/zh_CN/快速入门/5.0升级指南.md

@@ -0,0 +1,110 @@
+# 5.0升级指南
+
+## 一、概述
+
+主题：重构+体验
+
+支持从`4.x`版本直接升级，数据完全兼容，IDE支持最低版本为`2023.3`。
+
+## 二、新功能
+
+### 1、重构优化
+
+- 多项目打开方式重构：每个项目的接口相互隔离展示，不再放于同一棵树中。
+- 工具栏按钮：功能更集中，默认使用内置图标，可自行安装三方主题进行美化。
+- 接口树：
+  - 支持无限层级，目录层级以`/`分割。扫描接口默认为`module`和`controller`2级，可设置不展示`module`。
+  - 默认展示接口名称，同步"随处搜索"中的展示，可切换为`url`方式。
+  - 取消单击事件，双击事件可设置为跳转源码和显示请求内容。
+  - 复制URL调整为复制完整的URL，自动从当前选中的环境变量中读取`baseUrl`拼接。
+- 强化请求标签：无数量限制，通过标题右键菜单操作，可跳转到源码和接口树节点。
+- 请求参数保存/展示按钮调整为悬浮按钮，更直观。
+- 请求参数编辑新增环境变量选择按钮，位置同上，支持选择内置变量。
+- 导入导出接口重构，不再支持原因剪贴板方式。
+- UI设置中的大部分配置迁移到 `ToolWindow` 右键菜单中。
+- 工具箱展示方式由弹窗改为编辑器tab。
+- 国际化优先使用内置的文案，建议搭配官方的语言插件使用。
+- 扩展API优化：接入更简单方便。
+
+
+### 2、新增接口标记管理
+
+- 在接口右键菜单中，点击【管理标记】，对当前接口新增删除标记。
+
+![img.png](images/manage_tag.png)
+
+- 按标记过滤：在 `Toolbar`按钮中选择【标记过滤】按钮进行操作，选中会自动刷新接口树，只展示选中的接口；未选择则展示所有的接口。
+
+![img.png](images/manage_tag_filter.png)
+
+### 3、导入导出
+
+- 导入API：`Toolbar`中的导入按钮。
+
+![img.png](images/api_import.png)
+
+- 导出API：`Toolbar`中的导出按钮，接口树节点右键菜单`Export`。
+
+![img.png](images/api_export.png)
+
+### 4、新增运行时环境变量管理
+
+- 支持Java和Golang，启动应用时自动设置到应用的环境变量中
+- 在设置中管理环境变量，可导入导出
+- 文档: [运行参数管理](../核心功能/运行参数管理.md)
+
+![img.png](../核心功能/images/runenv.png)
+
+### 5、扫描接口URL中的未知字符串支持自定义替换规则
+
+对于扫描接口URL中的未知字符串，可自行配置替换规则，如 `${a.a}`替换为`/api`。可用于Mapping注解中包含常量等场景。
+
+![img.png](images/replacerule.png)
+
+### 6、ToolWindow菜单说明
+
+![img.png](images/toolwindowanction.png)
+
+- 在接口树中显示扫描接口模块：对扫描接口有效
+
+![img.png](images/showapimodule.png)
+
+- 在接口树中指定包名级数：按`.`分割
+
+![img.png](showCompletePackage.png)
+
+- 优先跳转到源码：选中时双击接口会跳转到源码，未选中时双击会自动打开接口。
+
+- ToolWindow视图切换
+
+![img.png](images/toolwindow_vertical.png)
+
+
+## 三、升级
+
+通过jetbrains IDE（`2023.3+`）安装/升级插件到5.x版本。安装后需重启IDE。如数据源使用了数据库方式，则需从`4.0`升级。
+
+## 四、订阅
+
+如未订阅，插件仍可以正常使用，包括之前的所有功能。[在jetbrains官网管理订阅](https://account.jetbrains.com/licenses) - [支持版本买断](https://sales.jetbrains.com/hc/en-gb/articles/207240845-What-is-a-perpetual-fallback-license)
+
+:fire: **
+_如果你想更加充分地体验订阅功能，作者免费赠送3个月兑换码。如有需要，可通过邮件联系作者，备注好需求和你的 [Jetbrains邮箱账号](https://account.jetbrains.com/profile-details) !!_
+**
+
+### 订阅方式：
+
+![](images/224750015247999.png)
+
+打开方式：
+IDE：Help -> Register
+
+如未订阅，可在IDE 插件设置中点击激活按钮，关闭设置后可打开激活弹窗。
+
+### 订阅查询：
+
+查询已订阅内容，可下载激活码离线激活，官方地址：https://account.jetbrains.com/licenses
+
+## 五、其他说明
+
+开源版本源码会更新到4.0最新版本，但涉及订阅功能部分将隐藏，开发者可自行构建开源版本使用。如有插件开发/使用的问题（不限于技术问题），可以在GitHub提问或者发邮件给我。

doc/zh_CN/扩展/API列表项扩展支持.md

@@ -2,7 +2,7 @@
 
 ## 概述
 支持扩展API列表项，实现一些个性化展示及操作。
-根据扩展点：`io.github.newhoo.restkit.restful.ep.RestItemDetailProvider`
+根据扩展点：`io.github.newhoo.restkit.open.ep.RestItemDetailProvider`
 ## 源码说明
 
 - RestItemDetailProvider

doc/zh_CN/扩展/多协议客户端支持.md

@@ -4,7 +4,7 @@
 
 支持扩展自定义协议发送的客户端，默认提供了http实现，可扩展实现Dubbo等。
 
-根据扩展点：`io.github.newhoo.restkit.restful.ep.RestClientProvider`
+根据扩展点：`io.github.newhoo.restkit.open.ep.RestClientProvider`
 
 ## 源码说明
 

doc/zh_CN/扩展/扩展简介.md

@@ -4,11 +4,11 @@
 
 从`2.0.1`版本开始提供了以下扩展点：
 
-- `io.github.newhoo.restkit.restful.ep.RestfulResolverProvider` 自定义restful接口扩展。
+- `io.github.newhoo.restkit.open.ep.RestfulResolverProvider` 自定义restful接口扩展。
 - `io.github.newhoo.restkit.restful.ep.LanguageResolverProvider` 自定义语言相关的操作，具体参考源码说明。
-- `io.github.newhoo.restkit.restful.ep.RestClientProvider` 自定义协议发送客户端，从`2.0.3`开始支持。
+- `io.github.newhoo.restkit.open.ep.RestClientProvider` 自定义协议发送客户端，从`2.0.3`开始支持。
 
 从`3.0.0`版本开始提供了以下扩展点：
 
-- `io.github.newhoo.restkit.datasource.ep.DataSourceProvider` 自定义数据源。
-- `io.github.newhoo.restkit.restful.ep.RestItemDetailProvider` API列表项扩展。
+- `io.github.newhoo.restkit.open.ep.DataSourceProvider` 自定义数据源。
+- `io.github.newhoo.restkit.open.ep.RestItemDetailProvider` API列表项扩展。

doc/zh_CN/扩展/自定义数据源支持.md

@@ -2,7 +2,7 @@
 
 ## 概述
 支持扩展自定义数据源，实现数据自定义目的地存储，默认提供了Ide和Sqlite方式实现。
-根据扩展点：`io.github.newhoo.restkit.datasource.ep.DataSourceProvider`
+根据扩展点：`io.github.newhoo.restkit.open.ep.DataSourceProvider`
 ## 源码说明
 
 - DataSourceProvider

doc/zh_CN/扩展/自定义框架支持.md

@@ -4,7 +4,7 @@
 
 目前支持类型包括扫**描类型**和**存储类型**。扫描类型支持由源码解析得到，不支持增加/更新/删除等操作。存储类型用于自定义API的增删改查，需自行提供存储方式，如文件存储、redis存储等。
 
-根据扩展点：`io.github.newhoo.restkit.restful.ep.RestfulResolverProvider`
+根据扩展点：`io.github.newhoo.restkit.open.ep.RestfulResolverProvider`
 
 ## 源码说明
 

doc/zh_CN/核心功能/工具箱.md

@@ -6,7 +6,7 @@
 ![1717342213206.png](images/1717342213206.png)
 
 ## 操作
-操作路径：`Toolwindow` -> `Toolbar` -> `打开工具箱`
+操作路径：`Toolwindow` -> `Title` -> `打开工具箱`
 
 ![img.png](images/1717503701714.png)
 

doc/zh_CN/核心功能/运行参数管理.md

@@ -0,0 +1,34 @@
+# 运行参数管理
+
+## 概述
+
+方便管理运行参数（包括Jvm），启动应用时，启用的环境变量和jvm参数将被自动设置到应用中。
+
+## 功能
+
+- 项目级参数管理
+- 全局(跨项目)参数管理
+
+## 配置
+
+在设置中添加启动参数。
+
+![runvariable.png](images/runvariable.png)
+
+![img.png](images/1717509596336.png)
+
+- 预览：预览启用的参数（鼠标Hover时可换行查看）
+- 参数表格说明
+
+| 列名     | 描述                              |
+|--------|---------------------------------|
+| NAME   | 参数key，不可为空                      |
+| VALUE  | 参数value。为空时，生成的内容为NAME内容（jvm参数） |
+| ENABLE | 是否启用                            |
+| GLOBAL | 是否为全局参数                         |
+
+## 其他
+
+- 运行时环境变量支持Golang和Java
+- Jvm启动参数依赖Java插件，如IDEA/Android Studio
+- 源自插件 <a href="https://plugins.jetbrains.com/plugin/13204-jvm-parameter">Jvm Parameter</a>，如果已经安装，需卸载，数据兼容。

doc/zh_CN/目录.md

@@ -19,7 +19,7 @@
 - [工具箱](核心功能/工具箱.md)
 - [命令中心](核心功能/命令中心.md)
 - [Git识别](核心功能/Git识别.md)
-- [Jvm参数管理](核心功能/Jvm参数管理.md)
+- [运行参数管理](核心功能/运行参数管理.md)
 
 [扩展](#)
 - [扩展简介](扩展/扩展简介.md)