doc for 2023.2.3

dromara · Dec 11, 2023 · c25d11c · c25d11c
1 parent e079445
commit c25d11c
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 9 deletions.
diff --git a/docs/.vuepress/public/img/2023.2.3/projectName.png b/docs/.vuepress/public/img/2023.2.3/projectName.png
diff --git a/docs/.vuepress/public/img/2023.2.3/projectName_en.png b/docs/.vuepress/public/img/2023.2.3/projectName_en.png
diff --git a/docs/en/guide/features/postmanSync.md b/docs/en/guide/features/postmanSync.md
@@ -3,12 +3,15 @@
 Version required: <Badge text="2023.2.3" />
 
 ::: tip
-To improve the data synchronized to postman, it is recommended to select `sync after api save` option in the postman config of the plugin
-then trigger the synchronization by save the api.
+To  make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
+then trigger the synchronization by saving the API.
 
 It is also recommended to use this function to synchronize the API instead of exporting
 :::
 
+![postmanSync](/img/2023.2.3/postmanSync_en.png)
+
+
 ## Api key
 
 API key is used to perform manual actions using the Postman Online API. These actions include **creating collections**, **creating directories**, **creating requests**, and more.

diff --git a/docs/en/guide/history.md b/docs/en/guide/history.md
@@ -44,18 +44,29 @@ and some plug-in versions are rendering components under specific systems (such
 ::: tip Sync API to Postman
 You only need to configure the token of Postman and the ID of the workspace to upload the API to Postman.Enjoy what fast request do not support.
 
-To improve the data synchronized to postman, it is recommended to select `sync after api save` option in the postman config of the plugin
-then trigger the synchronization by save the api.
+To  make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
+then trigger the synchronisation by saving the API.
 
 More details please refer [Postman sync](./features/postmanSync.md)
 :::
 
+::: tip Project name drop-down box automatically switches
+When generating parameters for APIs under different modules, if auto domain name is enabled, the project name drop-down box will automatically switch
+:::
+
 :::info Environment refactoring
 Environment contains Current value and Initial value. Initial value can be shared by submitting config fine in `.fastRequest/config/fastRequestCurrentProjectEnvironment.json`.
 
 ![environment](/img/2023.2.3/environment_en.png)
 :::
 
+::: info Project domain name addition optimization
+
+The module name is automatically recognized as a drop-down box option, and you can also customize it.
+
+![projectName](/img/2023.2.3/projectName.png)
+:::
+
 ::: info Add @fastRequestParseIgnore support for ignore parse field
 To ignore parsing for entity field, you can add `@fast Request Parse Ignore` to the annotation. The original annotation `@parse Ignore` is still applicable.
 
@@ -475,14 +486,14 @@ The clarity of the tool window icons has been optimised under the new UI.
 - <Badge text="Activation prompt optimization" type="info"/>
 - <Badge text="Reload api error in navigate when using Kotlin and Java in one project" type="danger"/>
 
-::: tip Add @fastRequestParseIgnore comment support for parse
+::: tip Add @parseIgnore comment support for parse
 
-The following code, the plugin will ignore parsing this field. Please use `@fastRequestParseIgnore`
+The following code, the plugin will ignore parsing this field. Please use `@parseIgnore`
 
 ```java
 /**
  * xxx description
- * @fastRequestParseIgnore
+ * @parseIgnore
  */
 private String someIgnoreField ;
 ```

diff --git a/docs/guide/features/postmanSync.md b/docs/guide/features/postmanSync.md
@@ -3,12 +3,15 @@
 版本要求: <Badge text="2023.2.3" />
 
 :::tip
-由于历史原因,历史保存的持久化数据丢失了一部分字段,为了能够将同步至postman的数据更完善,
+由于历史原因,历史保存的持久化数据丢失了一部分字段,为了能够将同步至postman的数据更完整,
 建议在插件postman配置中勾上`保存后同步`postman选项,通过保存操作来触发同步.
 
 同时推荐使用该功能来同步api而不是导出
 :::
 
+![postmanSync](/img/2023.2.3/postmanSync.png)
+
+
 ## Api key
 
 Api key 用于使用 Postman 在线 API 执行一些手工行为.例如**创建Collection**、**创建目录**、**创建 Request** 等行为.

diff --git a/docs/guide/history.md b/docs/guide/history.md
@@ -49,12 +49,16 @@ feat: <Badge text="新功能" type="tip"/> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span>
 ::: tip API同步至Postman
 仅需配置Postman的token和对应workspace的ID即可将API云上传到Postman.享受fast request不支持的功能.
 
-由于历史原因,历史保存的持久化数据丢失了一部分字段,为了能够将同步至postman的数据更完善,
+由于历史原因,历史保存的持久化数据丢失了一部分字段,为了能够将同步至postman的数据更完整,
 建议在插件postman配置中勾上保存后同步postman选项,通过保存操作来触发同步.
 
 更多详情参考[Postman 同步](./features/postmanSync.md)
 :::
 
+::: tip 自动域名切换项目名下拉框自动切换
+不同 Module 下的 API 生成参数的时候，如果开启了自动域名,自动切换项目名下拉框
+:::
+
 ::: info Environment重构
 Environment区分为本地值(Current value)和共享值(Initial value)
 
@@ -63,6 +67,14 @@ Initial value可以通过提交 `.fastRequest/config/fastRequestCurrentProjectEn
 ![environment](/img/2023.2.3/environment.png)
 :::
 
+::: info 项目域名添加优化
+
+自动识别 module 名称作为下拉框选项,也可以自定义输入.
+
+![projectName](/img/2023.2.3/projectName.png)
+:::
+
+
 ::: info 忽略字段使用@fastRequestParseIgnore
 针对实体类字段忽略解析,可以在注释中添加`@fastRequestParseIgnore`来实现,原来的注解`@parseIgnore`依然适用