This is an automated email from the ASF dual-hosted git repository.
sabersola pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 658a73f fix local model and ext plugin (#296)
658a73f is described below
commit 658a73fc31d4cde7d5ebdd382aa9291f21f8954e
Author: xiaoyu <[email protected]>
AuthorDate: Mon Sep 27 18:47:23 2021 +0800
fix local model and ext plugin (#296)
---
docs/developer/custom-plugin.md | 8 +++----
docs/developer/local-model.md | 24 +++++++++----------
.../current/developer/custom-plugin.md | 6 ++---
.../current/developer/local-model.md | 28 +++++++++++-----------
4 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/docs/developer/custom-plugin.md b/docs/developer/custom-plugin.md
index d0a1eb9..95812b2 100644
--- a/docs/developer/custom-plugin.md
+++ b/docs/developer/custom-plugin.md
@@ -272,10 +272,10 @@ public interface PluginDataHandler {
* Register defined class as a `Spring Bean`, or simply apply `@Component` in
implementation class.
```java
- @Bean
- public PluginDataHandler pluginDataHandler() {
- return new PluginDataHandler();
- }
+@Bean
+public PluginDataHandler pluginDataHandler() {
+ return new PluginDataHandler();
+}
```
## Dynamic loading
diff --git a/docs/developer/local-model.md b/docs/developer/local-model.md
index 1b1a2a9..c1fec13 100644
--- a/docs/developer/local-model.md
+++ b/docs/developer/local-model.md
@@ -40,7 +40,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**id**|String|False| plugin id|
+|**id**|String|False| |plugin id|
|**name**|String|True| |plugin name|
|**config**|String|False| |plugin configuration (Json format)|
|**role**|String|False| |plugin role |
@@ -155,7 +155,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**id**|String|False| selector id|
+|**id**|String|False| |selector id|
|**pluginName**|String|True| |plugin name|
|**name**|String|False| |Selector name (default is plugin:selector+random
number if not filled)|
|**matchMode**|Integer|False| |Matching mode (0:and;1:or), not filled with the
default generation And mode|
@@ -170,7 +170,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**paramType**|String|True| param
type(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True| |param
type(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True| |operator
(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |param mame(The uri parameter type can be passed
without)|
|**paramValue**|Integer|False| |param value|
@@ -236,7 +236,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**ruleName**|String|False| rule name|
+|**ruleName**|String|False| |rule name|
|**ruleHandler**|String|True| |Rule handler (different plugins pass different
values))|
|**matchMode**|Integer|False| |Matching pattern (0:and;1:or)|
|**conditionList**|[ConditionData](#ConditionData)|True| |Rule condition
collection (Json List object)|
@@ -245,7 +245,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**paramType**|String|True| param
type(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True| |param
type(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True| |operator
(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |param mame(The uri parameter type can be passed
without)|
|**paramValue**|Integer|False| |param value|
@@ -341,7 +341,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**id**|String|False| rule id|
+|**id**|String|False| |rule id|
|**pluginName**|String|True| |plugin name|
|**name**|String|False| |Rule name (default generation if not filled
plugin:rule+random number)|
|**selectorId**|String|True| |Selector id|
@@ -356,7 +356,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**paramType**|String|True| param
type(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True| |param
type(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True| |operator
(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |param mame(The uri parameter type can be passed
without)|
|**paramValue**|Integer|False| |param value|
@@ -448,7 +448,7 @@ POST
|Name|Type|Required|Default|Description|
|---|---|---|---|---|
-|**id**|String|False| ID|
+|**id**|String|False| |ID|
|**appName**|String|True| |app name|
|**contextPath**|String|True| |contextPath|
|**path**|String|True| |path|
@@ -457,7 +457,7 @@ POST
|**methodName**|String|True| |method name|
|**parameterTypes**|String|True| |parameter types|
|**rpcExt**|String|False| |rpc extension parameters (json objects)|
-|**enabled**|Boolean|False| Whether to turn on|
+|**enabled**|Boolean|False| |Whether to turn on|
### Delete
@@ -504,8 +504,8 @@ POST
|---|---|---|---|---|
|**appKey**|String|True| |app key|
|**appSecret**|String|True| |app secret|
-|**enabled**|Boolean|False| Whether to turn on|
-|**open**|Boolean|False| is open|
+|**enabled**|Boolean|False| |Whether to turn on|
+|**open**|Boolean|False| |is open|
|**paramDataList**|[AuthParamData](#AuthParamData)|false| |Parameter set, open
is true when you need to pass (Json list object)|
|**AuthPathData**|[AuthPathData](#AuthPathData)|false| |Path collection, open
is true when you need to pass (Json list object)|
@@ -522,7 +522,7 @@ POST
|---|---|---|---|---|
|**appName**|String|True| |app name|
|**path**|String|True| |path|
-|**enabled**|Boolean|False| Whether to turn on|
+|**enabled**|Boolean|False| |Whether to turn on|
### Delete
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/developer/custom-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/current/developer/custom-plugin.md
index 6ac46ac..57914d7 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/developer/custom-plugin.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/developer/custom-plugin.md
@@ -278,10 +278,10 @@ public interface PluginDataHandler {
* 注册成`Spring`的`bean`,参考如下或者直接在实现类上加 `@Component` 注解。
```java
- @Bean
+@Bean
public PluginDataHandler pluginDataHandler() {
- return new PluginDataHandler();
- }
+ return new PluginDataHandler();
+}
```
## 动态加载自定义插件
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/developer/local-model.md
b/i18n/zh/docusaurus-plugin-content-docs/current/developer/local-model.md
index 4cc04d1..d247af8 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/developer/local-model.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/developer/local-model.md
@@ -40,7 +40,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**id**|String|False| 插件ID|
+|**id**|String|False| |插件ID|
|**name**|String|True| |插件名称|
|**config**|String|False| |插件配置(Json格式)|
|**role**|String|False| |插件角色|
@@ -155,7 +155,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**id**|String|False| 选择器ID|
+|**id**|String|False| |选择器ID|
|**pluginName**|String|True| |插件名称|
|**name**|String|False| |选择器名称(不填则默认生成 plugin:selector+随机数字)|
|**matchMode**|Integer|False| |匹配模式(0:and;1:or),不填默认生成 And模式|
@@ -164,13 +164,13 @@ POST
|**enabled**|Boolean|False| |是否开启,不填默认生成 true|
|**logged**|Boolean|False| |是否打印日志,不填默认生成为false|
|**handle**|String|False| |选择器处理(Json对象,根据每个插件不同,传的对象不同)|
-|**conditionList**|[conditionList](#conditionList)|False|
|条件集合,自定义流量需要传,全流量不用传(Json List对象)|
+|**conditionList**|[Condition](#Condition)|False| |条件集合,自定义流量需要传,全流量不用传(Json
List对象)|
-##### <div id="conditionList">conditionList</div>
+##### <div id="Condition">Condition</div>
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**paramType**|String|True|
参数类型(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True|
|参数类型(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True|
|匹配方式(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |参数名称(uri 参数类型时候,可以不传)|
|**paramValue**|Integer|False| |匹配值|
@@ -235,7 +235,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**ruleName**|String|False| 规则名称|
+|**ruleName**|String|False| |规则名称|
|**ruleHandler**|String|True| |规则处理(不同的插件传不同的值)|
|**matchMode**|Integer|False| |匹配模式(0:and;1:or)|
|**conditionList**|[ConditionData](#ConditionData)|True| |规则条件集合(Json List对象)|
@@ -244,7 +244,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**paramType**|String|True|
参数类型(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True|
|参数类型(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True|
|匹配方式(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |参数名称(uri 参数类型时候,可以不传)|
|**paramValue**|Integer|False| |匹配值|
@@ -340,7 +340,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**id**|String|False| 规则ID|
+|**id**|String|False| |规则ID|
|**pluginName**|String|True| |插件名称|
|**name**|String|False| |规则名称(不填则默认生成 plugin:rule+随机数字)|
|**selectorId**|String|True| |选择器ID(不填则默认生成 plugin:rule+随机数字)|
@@ -355,7 +355,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**paramType**|String|True|
参数类型(post,uri,query,host,header,cookie,req_method,domain)|
+|**paramType**|String|True|
|参数类型(post,uri,query,host,header,cookie,req_method,domain)|
|**operator**|String|True|
|匹配方式(match,=,regex,>,<,contains,SpEL,Groovy,TimeBefore,TimeAfter)|
|**paramName**|String|False| |参数名称(uri 参数类型时候,可以不传)|
|**paramValue**|Integer|False| |匹配值|
@@ -447,7 +447,7 @@ POST
|名称|类型|是否必需|默认值|描述|
|---|---|---|---|---|
-|**id**|String|False| 元数据ID|
+|**id**|String|False| |元数据ID|
|**appName**|String|True| |应用名称|
|**contextPath**|String|True| |contextPath|
|**path**|String|True| |请求路径|
@@ -456,7 +456,7 @@ POST
|**methodName**|String|True| |方法名称|
|**parameterTypes**|String|True| |参数类型|
|**rpcExt**|String|False| |rpc扩展参数(json对象)|
-|**enabled**|Boolean|False| 是否开启|
+|**enabled**|Boolean|False| |是否开启|
### 删除元数据
@@ -503,8 +503,8 @@ POST
|---|---|---|---|---|
|**appKey**|String|True| |app key|
|**appSecret**|String|True| |app secret|
-|**enabled**|Boolean|False| 是否开启|
-|**open**|Boolean|False| 是否是开放平台|
+|**enabled**|Boolean|False| |是否开启|
+|**open**|Boolean|False| |是否是开放平台|
|**paramDataList**|[AuthParamData](#AuthParamData)|false|
|参数集合,open为true时候需要传(Json list对象)|
|**AuthPathData**|[AuthPathData](#AuthPathData)|false|
|路径集合,open为true时候需要传(Json list对象)|
@@ -521,7 +521,7 @@ POST
|---|---|---|---|---|
|**appName**|String|True| |应用名称|
|**path**|String|True| |路径|
-|**enabled**|Boolean|False| 是否开启|
+|**enabled**|Boolean|False| |是否开启|
### 删除