You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by de...@apache.org on 2022/10/08 12:31:08 UTC
[shenyu-website] branch main updated: Optimize ShenYu Rewrite Plugin Document (#784)
This is an automated email from the ASF dual-hosted git repository.
dengliming pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 4f364e544a Optimize ShenYu Rewrite Plugin Document (#784)
4f364e544a is described below
commit 4f364e544a4808da6e3bde821571a78269dd90a3
Author: Zihao Huang <hz...@gmail.com>
AuthorDate: Sat Oct 8 20:31:00 2022 +0800
Optimize ShenYu Rewrite Plugin Document (#784)
---
docs/plugin-center/http-process/rewrite-plugin.md | 96 +++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin-center/http-handle/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin-center/http-handle/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 94 ++++++++++++++++----
.../plugin/rewrite/rewrite_example_result.png | Bin 0 -> 112341 bytes
.../shenyu/plugin/rewrite/rewrite_example_rule.png | Bin 0 -> 116973 bytes
.../shenyu/plugin/rewrite/rewrite_rule_config.png | Bin 0 -> 122427 bytes
.../img/shenyu/plugin/rewrite/rewrite_use_en.png | Bin 0 -> 72622 bytes
.../img/shenyu/plugin/rewrite/rewrite_use_zh.png | Bin 0 -> 76279 bytes
.../plugin-center/http-handle/rewrite-plugin.md | 96 +++++++++++++++++----
.../plugin-center/http-handle/rewrite-plugin.md | 96 +++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 96 +++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 96 +++++++++++++++++----
.../plugin-center/http-process/rewrite-plugin.md | 96 +++++++++++++++++----
17 files changed, 948 insertions(+), 192 deletions(-)
diff --git a/docs/plugin-center/http-process/rewrite-plugin.md b/docs/plugin-center/http-process/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/docs/plugin-center/http-process/rewrite-plugin.md
+++ b/docs/plugin-center/http-process/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/http-process/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/http-process/rewrite-plugin.md
index 74c46923a2..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/http-process/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/http-process/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，允许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
index 0ac2ede1fb..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，还容许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
index 0ac2ede1fb..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，还容许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
index 74c46923a2..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，允许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
index 74c46923a2..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，允许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
index 74c46923a2..7e1ac62c34 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
@@ -4,38 +4,100 @@ keywords: ["rewrite"]
description: rewrite插件
---
-## 说明
+# 1. 概述
-* `Apache ShenYu` 网关在对目标服务进行代理调用的时候，允许用户使用 `rewrite` 插件来重写请求路径 。
+## 1.1 插件名称
+* Rewrite插件
-## 插件设置
+## 1.2 适用场景
-* 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite`，设置为开启。
+* 通过重写请求路径, 可以使用与目标服务不同的uri。
-* 在网关的 `pom.xml` 文件中添加 `rewrite` 的支持。
+## 1.3 插件功能
-* 如果用户不需要，可以把插件禁用。
+* 该插件用于重写请求uri。
-<img src="/img/shenyu/plugin/rewrite/rewrite_open.png" width="80%" height="80%" />
+## 1.4 插件代码
+* 核心模块 `shenyu-plugin-rewrite`
+
+* 核心类 `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 添加自哪个Shenyu版本
+
+* 2.4.0
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
+
+## 2.2 导入pom
+
+- 在网关的 `pom.xml` 文件中添加插件 maven 配置。
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* 选择器和规则设置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+## 2.3 启用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为开启。
+
+
+## 2.4 配置插件
+
+### 2.4.1 插件配置
+
+* 在使用前要启用插件。
+* 如果不再使用插件需要禁用。
+
+### 2.4.2 选择器配置
+
+* 请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 规则配置
+
+
+
+* 参数解释:
+ * `regex` : 匹配uri中要重写部分的正则表达式。
+ * `replace` : 替换的内容
+
+## 2.5 示例
+
+### 2.5.1 重新uri示例
+
+#### 2.5.1.1 运行 `shenyu-examples-http` 项目
+
+* 使用[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), 参考[](../../quick-start/quick-start-http#运行shenyu-examples-http项目)
+
+#### 2.5.1.1 插件配置
+
+* 参考[2.4.1](#241-插件配置)配置插件.
+
+#### 2.5.1.2 选择器配置
+
+* 参考[2.4.2](#242-选择器配置)配置选择器
+
+#### 2.5.1.3 规则配置
+
+
+
+请求 `/http/hello` 将被重写成`/hi`。
+
+#### 2.5.1.4 验证结果
+
+使用工具（如Postman）发起请求：
- * 只有匹配的请求，才会进行重写。
+
-## 场景
+# 3. 如何禁用插件
-* 顾名思义，重写插件就是对 `uri` 的重新定义。
-* 当匹配到请求后，设置自定义的路径，那么自定义的路径就会覆盖之前的真实路径。
-* 在调用的时候，就会使用用户自定义的路径。
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `rewrite` 设置为关闭。
diff --git a/static/img/shenyu/plugin/rewrite/rewrite_example_result.png b/static/img/shenyu/plugin/rewrite/rewrite_example_result.png
new file mode 100644
index 0000000000..1d3800eedd
Binary files /dev/null and b/static/img/shenyu/plugin/rewrite/rewrite_example_result.png differ
diff --git a/static/img/shenyu/plugin/rewrite/rewrite_example_rule.png b/static/img/shenyu/plugin/rewrite/rewrite_example_rule.png
new file mode 100644
index 0000000000..d6819acee8
Binary files /dev/null and b/static/img/shenyu/plugin/rewrite/rewrite_example_rule.png differ
diff --git a/static/img/shenyu/plugin/rewrite/rewrite_rule_config.png b/static/img/shenyu/plugin/rewrite/rewrite_rule_config.png
new file mode 100644
index 0000000000..8d943042cc
Binary files /dev/null and b/static/img/shenyu/plugin/rewrite/rewrite_rule_config.png differ
diff --git a/static/img/shenyu/plugin/rewrite/rewrite_use_en.png b/static/img/shenyu/plugin/rewrite/rewrite_use_en.png
new file mode 100644
index 0000000000..519bed78a4
Binary files /dev/null and b/static/img/shenyu/plugin/rewrite/rewrite_use_en.png differ
diff --git a/static/img/shenyu/plugin/rewrite/rewrite_use_zh.png b/static/img/shenyu/plugin/rewrite/rewrite_use_zh.png
new file mode 100644
index 0000000000..136f55620b
Binary files /dev/null and b/static/img/shenyu/plugin/rewrite/rewrite_use_zh.png differ
diff --git a/versioned_docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md b/versioned_docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/versioned_docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
+++ b/versioned_docs/version-2.4.0/plugin-center/http-handle/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.
diff --git a/versioned_docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md b/versioned_docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/versioned_docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
+++ b/versioned_docs/version-2.4.1/plugin-center/http-handle/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.
diff --git a/versioned_docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md b/versioned_docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/versioned_docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
+++ b/versioned_docs/version-2.4.2/plugin-center/http-process/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.
diff --git a/versioned_docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md b/versioned_docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/versioned_docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
+++ b/versioned_docs/version-2.4.3/plugin-center/http-process/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.
diff --git a/versioned_docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md b/versioned_docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
index 9641ece370..79996e1072 100644
--- a/versioned_docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
+++ b/versioned_docs/version-2.5.0/plugin-center/http-process/rewrite-plugin.md
@@ -4,36 +4,100 @@ keywords: ["rewrite"]
description: rewrite plugin
---
-## Explanation
+# 1. Overview
-* When making proxy invokes to the target service, Apache ShenYu gateway also allows users to rewrite the request path using the `rewrite` plugin.
+## 1.1 Plugin Name
-## Plugin Setting
+* Rewrite Plugin
-* In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` , set to enable.
-* Add `rewrite` support in the `pom.xml` file of the gateway.
-* If the user don't use, please disable the plugin in the background.
+## 1.2 Appropriate Scenario
-<img src="/img/shenyu/plugin/rewrite/rewrite_open_en.png" width="80%" height="80%" />
+* The request uri can be different from the target service by rewriting the path.
+## 1.3 Plugin functionality
+
+* This plugin is used to rewrite the request uri.
+
+## 1.4 Plugin code
+
+* Core Moudule `shenyu-plugin-rewrite`
+
+* Core Class `org.apache.shenyu.plugin.rewrite.RewritePlugin`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.4.0
+
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+- Import maven config in shenyu-bootstrap project's `pom.xml` file..
```xml
- <!-- apache shenyu rewrite plugin start-->
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-plugin-rewrite</artifactId>
- <version>${project.version}</version>
+ <version>${project.version}</version>
</dependency>
- <!-- apache shenyu rewrite plugin end-->
```
-* Selectors and rules, please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
-* Only those matched request will be rewritten.
+## 2.3 Enable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status enabled.
+
+
+## 2.4 Config plugin
+
+### 2.4.1 Plugin Config
+
+* Enable the plugin before using.
+* Disable the plugin if don't use.
+
+### 2.4.2 Selector Config
+
+* Please refer to: [Selector And Rule Config](../../user-guide/admin-usage/selector-and-rule).
+
+### 2.4.3 Rule Config
+
+
+
+* Param details:
+ * `regex`: The regular expression that matches the part of uri to be rewrited.
+ * `replace`: The content of replacement.
+
+## 2.5 Examples
+
+### 2.5.1 Example for rewriting uri
+
+#### 2.5.1.1 Run the shenyu-examples-http project
+
+* Use [shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http), please refer to [Run the shenyu-examples-http project](../../quick-start/quick-start-http#run-the-shenyu-examples-http-project)
+
+#### 2.5.1.1 Plugin Config
+
+* Refer to [2.4.1](#241-plugin-config) to configure plugin.
+
+#### 2.5.1.2 Selector Config
+
+* Refer to [2.4.2](#242-selector-config) to configure selector
+
+#### 2.5.1.3 Rule Config
+
+
+
+The request `/http/hello` would be rewrited to `/hi`
+
+#### 2.5.1.4 Check Result
-## Situation
+Use some tool (such as Postman) to make a request:
-* As the name suggests, rewrite is a redefinition of URI.
+
-* When the request is matched, set the user-defined path, and the user-defined path will overwrite the previous real path.
+# 3. How to disable plugin
-* When invoking, the user-defined path will be used.
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `rewrite` set Status disable.