doc

dromara · Jan 8, 2025 · 15259fa · 15259fa
1 parent d60ef4d
commit 15259fa
Show file tree

Hide file tree

Showing 13 changed files with 74 additions and 45 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -25,12 +25,12 @@ features:
 
   - title: 功能丰富
     icon: features
-    details: 一键生成 URL 和参数、脚本、API 导出到 Postman、SearchEveryWhere 搜索、发送 API 请求、下载文件、存储历史请求，各种功能一应俱全
+    details: 一键生成 URL 和参数、脚本、SearchEveryWhere 搜索、API 导出到 Postman、发送 API 请求、下载文件、存储历史请求，各种功能一应俱全
     link: /guide/features/
 
   - title: 轻量、界面友好
     icon: code-box-fill
-    details: 轻量，仅 16M 大小，并且提供一个非常直观的界面，好操作易上手
+    details: 轻量，仅 20M 大小，并且提供一个非常直观的界面，好操作易上手
     link: /guide/install.html
 
 head:
@@ -114,11 +114,9 @@ style="max-width:370px"
 
 ## 🎉 致谢
 
-**Restful Fast Request**简称**RFR**自从 2021 年上线以来获得了很多人的支持。目前微信社区群 1000 多人，下载超过 ![Downloads](https://img.shields.io/jetbrains/plugin/d/16988?color=FE2857)，感谢各位支持者的一路同行，我们会努力提升软件的人性化程度，同时也让软件变得有趣。
+**Fast Request** 简称 **FR** 。自从 2021 年上线以来获得了很多人的支持。目前微信社区群 1000 多人，下载超过 ![Downloads](https://img.shields.io/jetbrains/plugin/d/16988?color=FE2857)，感谢各位支持者的一路同行，我们会努力提升软件的人性化程度，同时也让软件变得有趣。
 
-感谢 OSCHINA 和 Gitee 官方平台对**RFR**项目的推荐和肯定。**Restful Fast Request**在 [**2021**](https://www.oschina.net/question/2918182_2324736) 年度获得"OSC 年度最受欢迎个人项目" <Badge vertical="baseline">Top 15</Badge> 殊荣。
-
-设计师森阳`[email protected]` logo设计
+感谢 OSCHINA 和 Gitee 官方平台对 **FR** 项目的推荐和肯定。**Restful Fast Request**在 [**2021**](https://www.oschina.net/question/2918182_2324736) 年度获得"OSC 年度最受欢迎个人项目" <Badge vertical="baseline">Top 15</Badge> 殊荣。
 
 <!-- @include: @src/contact.snippet.md -->
 

diff --git a/docs/contact.snippet.md b/docs/contact.snippet.md
@@ -2,7 +2,7 @@
 
 ## 🤝 联系我们
 
-如果遇到了问题，请通过以下方式联系我们，将会有更快为你解决问题，同时群里全部都是 Javaer，经常会讨论一些技术问题，热点新闻，跳槽，吐槽等，可以帮助你学到一些东西。
+如果您遇到了任何使用上的问题，请通过以下方式联系我们，将会有更快为你解决问题，同时群里全部都是 Javaer，经常会讨论一些技术问题，热点新闻，跳槽，吐槽等，可以帮助你学到一些东西。
 
 | ![微信技术群](https://img.shields.io/static/v1?label=wechat&message=微信技术群&logo=wechat&color=07C160) | [![twitter](https://img.shields.io/static/v1?label=Twitter&message=FastRequest666&logo=twitter&color=FC8D34)](https://twitter.com/FastRequest666) |
 | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -30,7 +30,7 @@ features:
 
   - title: Lightweight、User-friendly interface
     icon: code-box-fill
-    details: Only 16 MB size. Plugin provides a very intuitive interface
+    details: Only 20 MB size. Plugin provides a very intuitive interface
     link: /en/guide/install.html
 
 head:

diff --git a/docs/en/guide/buy.md b/docs/en/guide/buy.md
@@ -18,6 +18,8 @@ icon: buy
 
 Click **Activate Plugin**. Of course, you can also try the plugin first. It's free for 30 days. Please click start trial.
 
+Path: `Help(Menu) -> Register... -> Fast Request`
+
 ![activation page](/img/buy/activate_en.png)
 
 ## Step1: Click Buy license
@@ -27,7 +29,9 @@ Click **Activate Plugin**. Of course, you can also try the plugin first. It's fr
 ## step2: Choose a package
 
 - package 1: Monthly Subscription
-- package 2: Yearly Subscription(Recommended)
+- package 2: Yearly Subscription (Recommended)
+
+Directly links：[https://plugins.jetbrains.com/plugin/16988-fast-request--api-buddy/pricing](https://plugins.jetbrains.com/plugin/16988-fast-request--api-buddy/pricing)
 
 ![step2](/img/buy/step2.png)
 
@@ -46,7 +50,7 @@ Click next to enter the purchase confirmation page.
 
 > Online activation
 
-Click **help->Register Plugins...->Add New License**
+Click **Help(Menu) -> Register... -> Manage License**
 
 Log in to your JetBrains account.
 
@@ -68,7 +72,7 @@ Log in to your JetBrains account.
 
 ::: caution License info
 
-**Please keep your activation code information safe and do not leak the License information.**
+**Ensure keep your activation code information safe and don't leak the License information.**
 
 ![License](/img/buy/accountLicense.png)
 

diff --git a/docs/en/guide/faq.md b/docs/en/guide/faq.md
@@ -69,17 +69,6 @@ Click the plug-in settings button **Manage Configuration** and set the values of
 Please refer [<ColorIcon icon="domainConfig" /> Project-level domain config](./features/projectLevelDomainConfig.md)
 (Plugin version>=**2023.1.1**)
 
-## S: APIs lost
-
-So sorry to inform you that installing the 2023.1.3 version of (have been hidden) will cause loss of historical APIs, and you will need to manually retrieve the data. Here's what you need to do:
-
-0. Download 2023.1.3.2+ version of plugin
-1. Go to the .idea directory in your project, right-click and click on "Local history", find the change log about `.idea/FastRequestCollection.xml` (the title contains "Deleting"), and locate the last version. Copy the contents of this version and paste them into `.idea/fastRequest/fastRequestCollection.xml`
-2. Restart IntelliJ IDEA.
-3. Click on the icon <ColorIcon icon="dataTransfer" /> in the APIs tab and do transfer
-
-![dataTransfer20231](/img/faq/dataTransfer202313.png)
-
 ## S: Url error
 
 ![urlError](/img/skill/urlError_en.png)
@@ -160,7 +149,10 @@ Recommendation: There is no need to create a repo in Github, Gitee, and Gitlab i
 
 ## S: APIs echo
 
-For the saved API, you modify it again, and you need manually fill in the parameters and save <ColorIcon icon="saveNew" /> it. If you don't want the parameters you saved before at all, you can just click <ColorIcon icon="regenerate" />([Re generate](/guide/features/regenerate.md)).
+For the saved API, you modify it again,
+and you need to manually fill in the parameters and save <ColorIcon icon="save" /> it.
+If you don't want the parameters you saved before at all,
+you can click <ColorIcon icon="regenerate" />([Re generate](/guide/features/regenerate.md)).
 
 > Please ensure that click `save button` <ColorIcon icon="saveNew" /> every time you modify api params.
 
@@ -207,6 +199,8 @@ Click **help->Edit Custom Vm Options...**,add the following config in **idea.vmo
 
 ## Q: Response return Unexpected end of file from server
 
+It maybe caused by as follows
+
 ```
 1. Network connection was lost
 2. The server decided to close the connection
@@ -242,7 +236,7 @@ public class WebConfig {
 }
 ```
 
-## Q: Action buttons are not visible
+## Q: Action buttons not visible
 
 Click `Options` and check `Show Toolbar`
 
@@ -258,6 +252,8 @@ Left icon <ColorIcon icon="restfulFastRequest" /> missing.
 
 **A:** Open config `setting->Editor->Gutter icons->show gutter icon`
 
+**B:** Copy the file content then delete it and recreate it and paste it back. 
+
 ## Q: After entering the parameters, the API call found that the parameters were invalid
 
 **A:** Plugin version less than ==2022.2.3==, when editing a value in the table, you need to ==click in the blank space== after editing the value, then send the request. The bug has been fixed in the 2022.2.3+ version.
@@ -289,3 +285,14 @@ public class A{
     private int xx;
 }
 ```
+
+## S: APIs data lost
+
+So sorry to inform you that installing the 2023.1.3 version of (have been hidden) will cause loss of historical APIs, and you will need to manually retrieve the data. Here's what you need to do:
+
+0. Download 2023.1.3.2+ version of plugin
+1. Go to the .idea directory in your project, right-click and click on "Local history", find the change log about `.idea/FastRequestCollection.xml` (the title contains "Deleting"), and locate the last version. Copy the contents of this version and paste them into `.idea/fastRequest/fastRequestCollection.xml`
+2. Restart IntelliJ IDEA.
+3. Click on the icon <ColorIcon icon="dataTransfer" /> in the APIs tab and do transfer
+
+![dataTransfer20231](/img/faq/dataTransfer202313.png)
diff --git a/docs/en/guide/features/apiToPostman.md b/docs/en/guide/features/apiToPostman.md
@@ -1,3 +1,5 @@
 # APIs export to Postman
 
 ![export2postman](/img/export2postman.gif)
+
+Deprecated in new version，please refer to [<ColorIcon icon="postmanNew" /> Postman integration](/en/guide/features/postmanSync.md) or [<ColorIcon icon="openApi" /> OpenAPI export](/en/guide/features/openApi.md). 
diff --git a/docs/en/guide/introduce.md b/docs/en/guide/introduce.md
@@ -14,10 +14,10 @@ icon: restfulFastRequest
 [**<FontIcon icon="restfulFastRequest" />estful <i class="icon iconfont icon-rfr-f"></i>ast <FontIcon icon="restfulFastRequest" />equest**](https://plugins.jetbrains.com/plugin/16988-fast-request) is an IDEA plugin similar to Postman that helps developers debug APIs efficiently. It is a powerful restful API toolkit plugin which helps you quickly generate URL and params by the existing method.
 `Restful Fast Request = API debug tool + API manager tool + API search tool`. It has a beautiful interface to compose requests, inspect server responses, store your API request and export API request. Plugin helps you debug requests just in IntelliJ IDEA frame.
 
-Compared with the HTTP Client, Restful Fast Request not only has the built-in functions of the HTTP Client but also
+Compared with the HTTP Client, Fast Request not only has the built-in functions of the HTTP Client but also
 provides a friendly, easy-to-understand and intuitive interface, which makes it more convenient and simple for users to
 debug the API. At the same time, various types of parameters also provide different customization methods to make them
-more flexible. And it integrates additional features such as search, Postman integration, Swagger support and so on.
+more flexible. And it integrates additional features such as search, Postman integration, Swagger support, and other [Features](/en/guide/features/).
 
 ::: important PURPOSE  
 The purpose of the plugin is to simplify development and improve efficiency. Our vision is to become the best partner of IDEA, just like Contra's 1P, 2P, base-friend collocation, and double the efficiency.

diff --git a/docs/guide/buy.md b/docs/guide/buy.md
@@ -20,6 +20,8 @@ icon: buy
 
 点击**激活插件**，当然你也可以先免费试用插件 30 天，点击 start trial。
 
+路径： `Help(菜单栏) -> Register... -> Fast Request` 
+
 ![](/img/buy/activate.png)
 
 ## Step1: 点击 Buy license
@@ -31,6 +33,8 @@ icon: buy
 - 套餐 1: 按月计费订阅
 - 套餐 2: 按年计费订阅(推荐)
 
+直走链接：[https://plugins.jetbrains.com/plugin/16988-fast-request--api-buddy/pricing](https://plugins.jetbrains.com/plugin/16988-fast-request--api-buddy/pricing)
+
 ![](/img/buy/step2.png)
 
 ## Step3: 邮箱确认(非 jetbrains 账号方式购买)
@@ -44,11 +48,20 @@ icon: buy
 
 ![](/img/buy/step4.png)
 
+::: tip
+场景：支付页面发现只能用信用卡支付，无法使用微信、支付宝
+
+解决方案：打开链接 [https://account.jetbrains.com/profile-details](https://account.jetbrains.com/profile-details)
+
+`country/Region` 修改为 `China Mainland` 中国大陆再返回点击购买即可
+如果没有这个选项，可以换个账号用购买并使用离线激活来激活插件，或者邮件联系 <a href="mailto:[email protected]">[email protected]</a> 声明修改账号的 country/Region 成 `China Mainland` 中国大陆
+:::
+
 ## Step5: 填写 License 信息激活插件
 
 > 在线激活
 
-点击 **help->Register Plugins...->Add New License**
+点击 **Help(菜单栏) -> Register... -> Add New License**
 
 需要登录 Jetbrains 账号
 

diff --git a/docs/guide/faq.md b/docs/guide/faq.md
@@ -12,7 +12,7 @@ icon: faq
 
 [[toc]]
 
-## S: 如何忽略.fastRequest目录
+## S: 如何忽略 .fastRequest 目录
 >方式 1：在 IDEA 中不可见
 
 有些开发者不希望看到`.fastRequest`目录，可以前往 idea 设置中的`File Types`，在`Ignore files and folders`中添加`.fastRequest`即可
@@ -68,17 +68,6 @@ git config --global core.excludesFile ~/.gitignore_global
 请参考 [<ColorIcon icon="domainConfig" /> 项目级别域名配置](./features/projectLevelDomainConfig.md)
 (插件版本>=**2023.1.1**)
 
-## S: APIs 丢失
-
-非常抱歉，安装过 2023.1.3 版本的(已隐藏)会导致历史 apis 丢失，此时需要手动找回数据。==请不要回退插件版本==
-
-0. 下载插件版本>=2023.1.3.2+的版本
-1. 找到项目下的.idea 目录，右键并点击 Local history(本地历史记录)，找到关于`.idea/FastRequestCollection.xml`的变更日志(标题包含了 Deleting)，找到最后一个版本，把其中的内容拷贝到`.idea/fastRequest/fastRequestCollection.xml`中，
-2. 重启 idea
-3. 在 APIs tab 下点击图标<ColorIcon icon="dataTransfer" />并确认数据转移
-
-![dataTransfer20231](/img/faq/dataTransfer202313.png)
-
 ## S: Url 错误
 
 ![urlError](/img/skill/urlError.png)
@@ -161,7 +150,7 @@ def response = request.execute()
 
 针对保存后的 api，又进行了修改，那么你需要手动补参数并保存。如果你完全不想要之前的参数了，直接点击<ColorIcon icon="regenerate" />([重新生成](/guide/features/regenerate.md))
 
-> 请确保你每次修改参数后点击`保存`<ColorIcon icon="saveNew" />按钮
+> 请确保你每次修改参数后点击`保存`<ColorIcon icon="save" />按钮
 
 ## S: 最佳视觉效果
 
@@ -204,7 +193,9 @@ private static final String[] restrictedHeaders = {
 -Dsun.net.http.allowRestrictedHeaders=true
 ```
 
-## Q: 响应返回Unexpected end of file from server
+## Q: 响应返回 Unexpected end of file from server
+
+造成的原图大致如下
 
 ```
 1. 网络连接丢失
@@ -259,6 +250,8 @@ public class WebConfig {
 
 **B:** 检查是否安装了 forestx 插件，该插件目前会引起 Fast Request 插件图标不展示
 
+**C:** 复制该类内容删除该类并重新新建该类
+
 ## Q: 输入参数后调用 API 发现无效
 
 **A:** 插件版本小于 2022.2.3 的在 table 控件编辑某个值的时候，需要在编辑完值后==先在空白处点一下==，再发送请求，该问题在 2022.2.3+版本得到修复
@@ -290,3 +283,13 @@ public class A {
     private int xx;
 }
 ```
+## S: APIs 丢失
+
+非常抱歉，安装过 2023.1.3 版本的(已隐藏)会导致历史 apis 丢失，此时需要手动找回数据。==请不要回退插件版本==
+
+0. 下载插件版本>=2023.1.3.2+的版本
+1. 找到项目下的.idea 目录，右键并点击 Local history(本地历史记录)，找到关于`.idea/FastRequestCollection.xml`的变更日志(标题包含了 Deleting)，找到最后一个版本，把其中的内容拷贝到`.idea/fastRequest/fastRequestCollection.xml`中，
+2. 重启 idea
+3. 在 APIs tab 下点击图标<ColorIcon icon="dataTransfer" />并确认数据转移
+
+![dataTransfer20231](/img/faq/dataTransfer202313.png)
diff --git a/docs/guide/features/apiToPostman.md b/docs/guide/features/apiToPostman.md
@@ -4,3 +4,5 @@
 # API 导出到 Postman
 
 ![export2postman](/img/export2postman.gif)
+
+最新版本已废除，请移步[<ColorIcon icon="postmanNew" /> Postman 集成](./postmanSync.md) 或者 [<ColorIcon icon="openApi" /> OpenAPI导出](/guide/features/openApi.md)。
diff --git a/docs/guide/history.md b/docs/guide/history.md
@@ -7,7 +7,7 @@ icon: changelog
 
 [**收费版 VS 免费版**](./versionCompare.md)
 
-购买**License**流程请参考[**购买插件**](./buy.md) 或者进入微信群里查看**群公告**，Issue 提报请到[_Github_](https://github.com/dromara/fast-request/issues)
+购买**License**流程请参考[**购买插件**](./buy.md)，Issue 提报请到[_Github_](https://github.com/dromara/fast-request/issues)
 
 | ![微信技术群](https://img.shields.io/static/v1?label=wechat&message=微信技术群&logo=wechat&color=07C160) | [![twitter](https://img.shields.io/static/v1?label=Twitter&message=FastRequest666&logo=twitter&color=FC8D34)](https://twitter.com/FastRequest666) |
 | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/guide/introduce.md b/docs/guide/introduce.md
@@ -10,9 +10,9 @@ icon: restfulFastRequest
 ![Version](https://img.shields.io/jetbrains/plugin/v/16988?logo=IntelliJ%20IDEA) ![Downloads](https://img.shields.io/jetbrains/plugin/d/16988?color=FE2857) ![JetBrains Plugins](https://img.shields.io/jetbrains/plugin/r/rating/16988) [![Slack](https://img.shields.io/static/v1?label=Slack&message=Fast%20Request&logo=slack&color=38B580)](https://join.slack.com/t/restfulfastrequest/shared_invite/zt-1we57vum8-TALhTHI2uNmPF2bx1NDyWw)
 
 [**<FontIcon icon="restfulFastRequest" />estful <i class="icon iconfont icon-rfr-f"></i>ast <FontIcon icon="restfulFastRequest" />equest**](https://plugins.jetbrains.com/plugin/16988-fast-request) 是一个类似于 Postman 的 IDEA 插件。它是一个强大的 restful api 工具包插件，可以根据已有的方法帮助您快速生成 url 和 params。
-`Restful Fast Request = API调试工具 + API管理工具 + API搜索工具`。 它有一个漂亮的界面来完成请求、检查服务器响应、存储你的 api 请求和导出 api 请求。插件帮助你在 IDEA 界面内更快更高效得调试你的 API
+`Restful Fast Request = API调试工具 + API管理工具 + API搜索工具`。 它有一个漂亮的界面来完成请求、检查服务器响应、存储你的 api 请求和导出 api 请求。插件帮助你在 IDEA 界面内更快更高效得调试你的 API。
 
-对比于 HTTP Client，Fast Request 不仅拥有 HTTP Client 内置的功能，还提供了友好易懂直观的界面，让使用者调试 API 的时候能够更加方便、简捷。同时各种类型参数也提供了不同的定制方式，更加灵活。而且集成了搜索、Postman 集成，Swagger 支持等额外的功能。
+对比于 HTTP Client，Fast Request 不仅拥有 HTTP Client 内置的功能，还提供了友好易懂直观的界面，让使用者调试 API 的时候能够更加方便、简捷。同时各种类型参数也提供了不同的定制方式，更加灵活。而且集成了搜索、Postman 集成，Swagger 支持等额外的[功能](/guide/features/)。
 
 ::: important 宗旨
 

diff --git a/docs/guide/whatsnew.md b/docs/guide/whatsnew.md
@@ -9,7 +9,7 @@ icon: whats-new
 
 [**收费版 VS 免费版->**](./versionCompare.md)
 
-购买**License**流程请参考[**购买插件**](./buy.md) 或者进入微信群里查看**群公告**
+购买**License**流程请参考[**购买插件**](./buy.md)
 
 Issue 提报请到[_Github_](https://github.com/dromara/fast-request/issues)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,3 +4,5 @@
		# API 导出到 Postman

		![export2postman](/img/export2postman.gif)

		最新版本已废除，请移步[<ColorIcon icon="postmanNew" /> Postman 集成](./postmanSync.md) 或者 [<ColorIcon icon="openApi" /> OpenAPI导出](/guide/features/openApi.md)。