This is an automated email from the ASF dual-hosted git repository.
xiaoyu 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 82e1339b4d [ISSUE 716] Fix user-guide configuration error. (#735)
82e1339b4d is described below
commit 82e1339b4de788a65be10878ec4388446ca001ce
Author: lahmxu <[email protected]>
AuthorDate: Tue Sep 6 20:56:53 2022 +0800
[ISSUE 716] Fix user-guide configuration error. (#735)
* [doc: user guide] add grpc configuration error
* [doc: user guide] add http configuration error
---
docs/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
docs/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../current/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../current/user-guide/http-proxy.md | 22 ++++++++++++++++++++--
.../version-2.4.0/user-guide/grpc-proxy.md | 18 ++++++++++++++++--
.../version-2.4.0/user-guide/http-proxy.md | 21 +++++++++++++++++----
.../version-2.4.1/user-guide/grpc-proxy.md | 18 ++++++++++++++++--
.../version-2.4.1/user-guide/http-proxy.md | 18 ++++++++++++++++--
.../version-2.4.2/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.4.2/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../version-2.4.3/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.4.3/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../version-2.5.0/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.5.0/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../version-2.4.0/user-guide/grpc-proxy.md | 19 ++++++++++++++++---
.../version-2.4.0/user-guide/http-proxy.md | 20 +++++++++++++++++---
.../version-2.4.1/user-guide/grpc-proxy.md | 19 ++++++++++++++++---
.../version-2.4.1/user-guide/http-proxy.md | 18 ++++++++++++++++--
.../version-2.4.2/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.4.2/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../version-2.4.3/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.4.3/user-guide/http-proxy.md | 20 +++++++++++++++++++-
.../version-2.5.0/user-guide/grpc-proxy.md | 22 ++++++++++++++++++++--
.../version-2.5.0/user-guide/http-proxy.md | 20 +++++++++++++++++++-
24 files changed, 443 insertions(+), 46 deletions(-)
diff --git a/docs/user-guide/grpc-proxy.md b/docs/user-guide/grpc-proxy.md
index 52db31240d..2ba7da527b 100644
--- a/docs/user-guide/grpc-proxy.md
+++ b/docs/user-guide/grpc-proxy.md
@@ -32,7 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
@@ -56,8 +56,26 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/docs/user-guide/http-proxy.md b/docs/user-guide/http-proxy.md
index c63b62e318..72fb2fe492 100644
--- a/docs/user-guide/http-proxy.md
+++ b/docs/user-guide/http-proxy.md
@@ -37,7 +37,7 @@ For details about data synchronization configurations, see
[Data Synchronization
Please refer
this：[shenyu-examples-http](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
```xml
<dependency>
@@ -47,6 +47,24 @@ For details about data synchronization configurations, see
[Data Synchronization
</dependency>
```
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
+
* SpringMvc
Please refer
this：[shenyu-examples-springmvc](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-springmvc)
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/grpc-proxy.md
index ccc3f30a11..1301f791df 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/grpc-proxy.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,26 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/http-proxy.md
index 00573cef1a..ec447b37e9 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/http-proxy.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/http-proxy.md
@@ -36,7 +36,7 @@ description: Http服务接入
可以参考：[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
```xml
<dependency>
@@ -44,7 +44,25 @@ description: Http服务接入
<artifactId>shenyu-spring-boot-starter-client-springmvc</artifactId>
<version>${shenyu.version}</version>
</dependency>
- ```
+ ```
+
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
* `SpringMvc` 用户
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/grpc-proxy.md
index ff8a4c2cef..ddd894106e 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/grpc-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/incubator-shenyu/tree/v2.4.0/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,22 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:8080
+ nacosNameSpace: ShenyuRegisterCenter
+ port: 8080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/http-proxy.md
index 7f8717608b..aab5057cd4 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/http-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.0/user-guide/http-proxy.md
@@ -37,16 +37,29 @@ description: Http服务接入
* `SpringBoot` 用户
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
-```xml
+ ```xml
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-client-springmvc</artifactId>
<version>${shenyu.version}</version>
</dependency>
- ```
-
+ ```
+
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ contextPath: /http
+ appName: http
+ port: 8189
+ nacosNameSpace: ShenyuRegisterCenter
+ ```
* `SpringMvc` 用户
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/grpc-proxy.md
index e2f71dccad..c8bce98b8d 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/grpc-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.1/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,22 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:8080
+ nacosNameSpace: ShenyuRegisterCenter
+ port: 8080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/http-proxy.md
index 8417275ad5..6958974390 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/http-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.1/user-guide/http-proxy.md
@@ -36,7 +36,7 @@ description: Http服务接入
可以参考：[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
```xml
<dependency>
@@ -46,7 +46,21 @@ description: Http服务接入
</dependency>
```
- 在你的 `controller` 的接口上加上 `@ShenyuSpringMvcClient` 注解。
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ contextPath: /http
+ appName: http
+ port: 8189
+ nacosNameSpace: ShenyuRegisterCenter
+ ```
+
+ 3. 在你的 `controller` 的接口上加上 `@ShenyuSpringMvcClient` 注解。
你可以把注解加到 `Controller` 类上面，里面的`path`属性则为前缀，如果含有 `/**` 代表你的整个接口需要被网关代理。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/grpc-proxy.md
index 91013a3ecb..94b6445818 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/grpc-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.2/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,26 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/http-proxy.md
index 4d6252e8c3..e96c64f39a 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/http-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.2/user-guide/http-proxy.md
@@ -36,7 +36,7 @@ description: Http服务接入
可以参考：[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
```xml
<dependency>
@@ -45,6 +45,24 @@ description: Http服务接入
<version>${shenyu.version}</version>
</dependency>
```
+
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
* `SpringMvc` 用户
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/grpc-proxy.md
index 6982e10c4a..a7e6d2454c 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/grpc-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.3/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,26 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/http-proxy.md
index 4d6252e8c3..336f93a62e 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/http-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.4.3/user-guide/http-proxy.md
@@ -36,7 +36,7 @@ description: Http服务接入
可以参考：[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
```xml
<dependency>
@@ -46,6 +46,24 @@ description: Http服务接入
</dependency>
```
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
+
* `SpringMvc` 用户
可以参考：[shenyu-examples-springmvc](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-springmvc)
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/grpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/grpc-proxy.md
index f0ff5a18de..b630b56279 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/grpc-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/grpc-proxy.md
@@ -33,7 +33,7 @@ description: gRPC服务接入
可以参考：
[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.5.0/shenyu-examples/shenyu-examples-grpc)
-* 在由`gRPC`构建的微服务中，引入如下依赖：
+1. 在由`gRPC`构建的微服务中，引入如下依赖：
```xml
<dependency>
@@ -56,8 +56,26 @@ mvn protobuf:compile //编译消息对象
mvn protobuf:compile-custom //依赖消息对象,生成接口服务
```
+2. 在 application.yaml 增加如下配置：
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
-在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 -> rpc
proxy -> grpc`，会看到自动注册的选择器和规则信息。
+3. 在`gRPC`服务接口实现类上加上 `@ShenyuGrpcClient` 注解。启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> grpc`，会看到自动注册的选择器和规则信息。
示例：
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/http-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/http-proxy.md
index 00573cef1a..4a74681f63 100644
---
a/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/http-proxy.md
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.5.0/user-guide/http-proxy.md
@@ -36,7 +36,7 @@ description: Http服务接入
可以参考：[shenyu-examples-http](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-http)
- 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
+ 1. 在你的`http`服务中的 `pom.xml`文件 新增如下依赖:
```xml
<dependency>
@@ -46,6 +46,24 @@ description: Http服务接入
</dependency>
```
+ 2. 在 application.yaml 增加如下配置：
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
+
* `SpringMvc` 用户
可以参考：[shenyu-examples-springmvc](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-springmvc)
diff --git a/versioned_docs/version-2.4.0/user-guide/grpc-proxy.md
b/versioned_docs/version-2.4.0/user-guide/grpc-proxy.md
index a73408515e..9ab4364e25 100644
--- a/versioned_docs/version-2.4.0/user-guide/grpc-proxy.md
+++ b/versioned_docs/version-2.4.0/user-guide/grpc-proxy.md
@@ -32,8 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/incubator-shenyu/tree/v2.4.0/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
-
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
<dependency>
@@ -56,8 +55,22 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:8080
+ nacosNameSpace: ShenyuRegisterCenter
+ port: 8080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/versioned_docs/version-2.4.0/user-guide/http-proxy.md
b/versioned_docs/version-2.4.0/user-guide/http-proxy.md
index 17ae88c171..deb93c6324 100644
--- a/versioned_docs/version-2.4.0/user-guide/http-proxy.md
+++ b/versioned_docs/version-2.4.0/user-guide/http-proxy.md
@@ -42,15 +42,29 @@ Please refer
this：[shenyu-examples-http](https://github.com/apache/incubator-s
* SpringBoot
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
-```xml
+ ```xml
<dependency>
<groupId>org.apache.shenyu</groupId>
<artifactId>shenyu-spring-boot-starter-client-springmvc</artifactId>
<version>${shenyu.version}</version>
</dependency>
- ```
+ ```
+
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ contextPath: /http
+ appName: http
+ port: 8189
+ nacosNameSpace: ShenyuRegisterCenter
+ ```
* SpringMvc
diff --git a/versioned_docs/version-2.4.1/user-guide/grpc-proxy.md
b/versioned_docs/version-2.4.1/user-guide/grpc-proxy.md
index a472d69bf1..39e98e3df8 100644
--- a/versioned_docs/version-2.4.1/user-guide/grpc-proxy.md
+++ b/versioned_docs/version-2.4.1/user-guide/grpc-proxy.md
@@ -32,8 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.1/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
-
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
<dependency>
@@ -56,8 +55,22 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:8080
+ nacosNameSpace: ShenyuRegisterCenter
+ port: 8080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/versioned_docs/version-2.4.1/user-guide/http-proxy.md
b/versioned_docs/version-2.4.1/user-guide/http-proxy.md
index e6cf230816..fdde51d5bc 100644
--- a/versioned_docs/version-2.4.1/user-guide/http-proxy.md
+++ b/versioned_docs/version-2.4.1/user-guide/http-proxy.md
@@ -37,7 +37,7 @@ For details about data synchronization configurations, see
[Data Synchronization
Please refer
this：[shenyu-examples-http](https://github.com/apache/shenyu/tree/v2.4.1/shenyu-examples/shenyu-examples-http)
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
```xml
<dependency>
@@ -47,7 +47,21 @@ For details about data synchronization configurations, see
[Data Synchronization
</dependency>
```
- Add this annotation `@ShenyuSpringMvcClient` in your `controller` interface.
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ client:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ contextPath: /http
+ appName: http
+ port: 8189
+ nacosNameSpace: ShenyuRegisterCenter
+ ```
+
+ 3. Add this annotation `@ShenyuSpringMvcClient` in your `controller`
interface.
You can apply the annotation to class-level in a controller. The name of the
`path` variable is prefix and `/**` will apply proxy for entire interfaces.
diff --git a/versioned_docs/version-2.4.2/user-guide/grpc-proxy.md
b/versioned_docs/version-2.4.2/user-guide/grpc-proxy.md
index 7e25d7d6ce..fdca3d58b8 100644
--- a/versioned_docs/version-2.4.2/user-guide/grpc-proxy.md
+++ b/versioned_docs/version-2.4.2/user-guide/grpc-proxy.md
@@ -32,7 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.2/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
@@ -56,8 +56,26 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/versioned_docs/version-2.4.2/user-guide/http-proxy.md
b/versioned_docs/version-2.4.2/user-guide/http-proxy.md
index 3615cdfb25..9f0a3beb5c 100644
--- a/versioned_docs/version-2.4.2/user-guide/http-proxy.md
+++ b/versioned_docs/version-2.4.2/user-guide/http-proxy.md
@@ -37,7 +37,7 @@ For details about data synchronization configurations, see
[Data Synchronization
Please refer
this：[shenyu-examples-http](https://github.com/apache/shenyu/tree/v2.4.2/shenyu-examples/shenyu-examples-http)
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
```xml
<dependency>
@@ -47,6 +47,24 @@ For details about data synchronization configurations, see
[Data Synchronization
</dependency>
```
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
+
* SpringMvc
Please refer
this：[shenyu-examples-springmvc](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-springmvc)
diff --git a/versioned_docs/version-2.4.3/user-guide/grpc-proxy.md
b/versioned_docs/version-2.4.3/user-guide/grpc-proxy.md
index f94f34ccaa..f93c287684 100644
--- a/versioned_docs/version-2.4.3/user-guide/grpc-proxy.md
+++ b/versioned_docs/version-2.4.3/user-guide/grpc-proxy.md
@@ -32,7 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.4.3/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
@@ -56,8 +56,26 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/versioned_docs/version-2.4.3/user-guide/http-proxy.md
b/versioned_docs/version-2.4.3/user-guide/http-proxy.md
index c993f95bf0..75714b696f 100644
--- a/versioned_docs/version-2.4.3/user-guide/http-proxy.md
+++ b/versioned_docs/version-2.4.3/user-guide/http-proxy.md
@@ -37,7 +37,7 @@ For details about data synchronization configurations, see
[Data Synchronization
Please refer
this：[shenyu-examples-http](https://github.com/apache/shenyu/tree/v2.4.3/shenyu-examples/shenyu-examples-http)
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
```xml
<dependency>
@@ -47,6 +47,24 @@ For details about data synchronization configurations, see
[Data Synchronization
</dependency>
```
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
+
* SpringMvc
Please refer
this：[shenyu-examples-springmvc](https://github.com/apache/incubator-shenyu/tree/master/shenyu-examples/shenyu-examples-springmvc)
diff --git a/versioned_docs/version-2.5.0/user-guide/grpc-proxy.md
b/versioned_docs/version-2.5.0/user-guide/grpc-proxy.md
index 085008bf3d..7ac749be9f 100644
--- a/versioned_docs/version-2.5.0/user-guide/grpc-proxy.md
+++ b/versioned_docs/version-2.5.0/user-guide/grpc-proxy.md
@@ -32,7 +32,7 @@ Add the following dependencies in the gateway's `pom.xml`
file:
You can refer
to：[shenyu-examples-grpc](https://github.com/apache/shenyu/tree/v2.5.0/shenyu-examples/shenyu-examples-grpc)
.
-* In the microservice built by `gRPC`, add the following dependencies:
+1. In the microservice built by `gRPC`, add the following dependencies:
```xml
@@ -56,8 +56,26 @@ mvn protobuf:compile
mvn protobuf:compile-custom
```
-Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
+2. Add the following configuration to application.yaml:
+
+```yaml
+shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181 #http://localhost:2379
#localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ grpc:
+ props:
+ contextPath: /grpc
+ appName: grpc
+ ipAndPort: 127.0.0.1:38080
+ port: 38080
+```
+3. Add `@ShenyuGrpcClient` Annotation on the `gRPC` service interface
implementation class. Start your service provider, after successful
registration, in the background management system go to PluginList -> rpc proxy
-> gRPC, you will see automatic registration of selectors and rules information.
Example:
diff --git a/versioned_docs/version-2.5.0/user-guide/http-proxy.md
b/versioned_docs/version-2.5.0/user-guide/http-proxy.md
index 22058cfe16..0b55383e38 100644
--- a/versioned_docs/version-2.5.0/user-guide/http-proxy.md
+++ b/versioned_docs/version-2.5.0/user-guide/http-proxy.md
@@ -37,7 +37,7 @@ For details about data synchronization configurations, see
[Data Synchronization
Please refer
this：[shenyu-examples-http](https://github.com/apache/shenyu/tree/v2.5.0/shenyu-examples/shenyu-examples-http)
- Add the following dependencies to the `pom.xml` file in your `Http` service:
+ 1. Add the following dependencies to the `pom.xml` file in your `Http`
service:
```xml
<dependency>
@@ -46,6 +46,24 @@ For details about data synchronization configurations, see
[Data Synchronization
<version>${shenyu.version}</version>
</dependency>
```
+
+ 2. Add the following configuration to application.yaml:
+
+ ```yaml
+ shenyu:
+ register:
+ registerType: http #zookeeper #etcd #nacos #consul
+ serverLists: http://localhost:9095 #localhost:2181
#http://localhost:2379 #localhost:8848
+ props:
+ username: admin
+ password: 123456
+ client:
+ http:
+ props:
+ contextPath: /http
+ appName: http
+ # port: 8189
+ ```
* SpringMvc
