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 a57f10dc35a add: brpc docs (#849)
a57f10dc35a is described below
commit a57f10dc35a57ecdbfcc7facec7104dd68080acd
Author: SongTao Zhuang <[email protected]>
AuthorDate: Mon Jan 16 14:34:59 2023 +0800
add: brpc docs (#849)
Co-authored-by: 庄松涛 <[email protected]>
---
docs/plugin-center/proxy/brpc-plugin.md | 77 ++++++++++++++++
docs/quick-start/quick-start-brpc.md | 66 ++++++++++++++
docs/user-guide/brpc-proxy.md | 99 ++++++++++++++++++++
.../current/plugin-center/proxy/brpc-plugin.md | 75 ++++++++++++++++
.../current/quick-start/quick-start-brpc.md | 65 ++++++++++++++
.../current/user-guide/brpc-proxy.md | 100 +++++++++++++++++++++
static/img/shenyu/plugin/brpc/metadata.png | Bin 0 -> 243639 bytes
static/img/shenyu/plugin/brpc/metadata_en.png | Bin 0 -> 232205 bytes
static/img/shenyu/quick-start/brpc/brpc_open.png | Bin 0 -> 267484 bytes
.../img/shenyu/quick-start/brpc/brpc_open_en.png | Bin 0 -> 293067 bytes
.../quick-start/brpc/idea-http-test-brpc.png | Bin 0 -> 556400 bytes
static/img/shenyu/quick-start/brpc/rule-list.png | Bin 0 -> 304247 bytes
12 files changed, 482 insertions(+)
diff --git a/docs/plugin-center/proxy/brpc-plugin.md
b/docs/plugin-center/proxy/brpc-plugin.md
new file mode 100644
index 00000000000..3979d27e27b
--- /dev/null
+++ b/docs/plugin-center/proxy/brpc-plugin.md
@@ -0,0 +1,77 @@
+---
+title: Brpc Plugin
+keywords: ["brpc-plugin"]
+description: brpc-plugin
+---
+
+# 1. Overview
+
+## 1.1 Plugin Name
+
+* Brpc Plugin
+
+## 1.2 Appropriate Scenario
+
+* a plugin that converts http protocol requests into the Brpc framework
protocol
+
+## 1.3 Plugin code
+
+* Core Module `shenyu-plugin-brpc`
+
+* Core Class `org.apache.shenyu.plugin.brpc.BrpcPlugin`
+
+## 1.4 Added Since Which shenyu version
+
+* Since ShenYu 2.5.1
+
+# 2. Brpc plugin
+
+
+## 2.1 Plugin Setting
+
+* Add related dependencies and enable plugin, please refer to: [Quick start
with Brpc](../../quick-start/quick-start-brpc) .
+
+* `Brpc` client access, please refer to: [Brpc
Proxy](../../user-guide/brpc-proxy) .
+
+
+## 2.2 Metadata
+
+Each `Brpc` interface method, will correspond to a metadata, when the `Brpc`
application client access to the `Apache ShenYu` gateway, will be automatically
registered, can be viewed in the `shenyu-admin` background management system of
the BasicConfig --> Metadata management.
+
+<img src="/img/shenyu/plugin/brpc/metadata_en.png" width="100%" height="100%"
/>
+
+
+* AppName: specifies the name of the application to which the metadata belongs.
+
+* MethodName: the name of the method to call.
+
+* Path: http request path.
+
+* PathDescribe: the description of the path is easy to view.
+
+* ParamsType: the parameters are separated by commas (,) in the order of
interface parameter types.
+
+* RpcExpand: description of each interface in a `Brpc` service. For example,
here is the interface information for the `Brpc` service:
+
+
+
+```json
+{
+ "methodInfo":[
+ {
+ "methodName":"getUser",
+ "paramTypes":[
+ {
+ "left":"java.lang.Long",
+ "right":"userId"
+ }
+ ]
+ }
+ ]
+}
+```
+
+
+* Interface: The fully qualified class name of the `Brpc` interface.
+
+* RpcType：choose `Brpc`.
diff --git a/docs/quick-start/quick-start-brpc.md
b/docs/quick-start/quick-start-brpc.md
new file mode 100644
index 00000000000..4e66f0d53b7
--- /dev/null
+++ b/docs/quick-start/quick-start-brpc.md
@@ -0,0 +1,66 @@
+---
+title: Quick start with Brpc
+description: Brpc quick start
+---
+
+This document introduces how to quickly access the Apache ShenYu gateway using
Brpc. You can get the code example of this document by clicking
[here](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc).
+
+
+## Environment to prepare
+
+
+Please refer to the deployment to select a way to start shenyu-admin. For
example, start the Apache ShenYu gateway management system through [local
deployment](../deployment/deployment-local) .
+
+After successful startup, you need to open the Brpc plugin on in the
BasicConfig `->` Plugin.
+
+<img src="/img/shenyu/quick-start/brpc/brpc_open_en.png" width="60%"
height="50%" />
+
+If you are a startup gateway by means of source, can be directly run the
ShenyuBootstrapApplication of shenyu-bootstrap module.
+
+> Note: Before starting, make sure the gateway has added dependencies.
+
+Import the gateway proxy plugin for `Brpc` and add the following dependencies
to the gateway's `pom.xml` file:
+
+
+```xml
+ <!-- apache shenyu brpc plugin -->
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-brpc</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+```
+
+
+
+## Run the shenyu-examples-brpc project
+
+Download
[shenyu-examples-brpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc).
+
+Run main method of
`org.apache.shenyu.examples.brpc.service.TestBrpcApplication` to start this
project.
+
+The following log appears when the startup is successful:
+
+```shell
+2023-01-11 23:09:37.593 INFO 96741 --- [or_consumer_-19]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/allName","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"allName","ruleName":"/brpc/allName","rpcExt":"{\"methodInfo\":[{\"methodName\":\"allName\",\"paramTypes\":[]}]}","enabled":true,"host":"127.0.0.1","port":8005,"pluginNames":[],"registerMe
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-21]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/userMap","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"userMap","ruleName":"/brpc/userMap","parameterTypes":"java.lang.Long","rpcExt":"{\"methodInfo\":[{\"methodName\":\"userMap\",\"paramTypes\":[{\"left\":\"java.lang.Long\",\"right\":\"userI
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-17]
o.a.s.r.client.http.utils.RegisterUtils : uri client register success:
{"appName":"brpc","contextPath":"/brpc","rpcType":"brpc","host":"127.0.0.1","port":8005}
+2023-01-11 23:09:37.612 INFO 96741 --- [or_consumer_-20]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/getUserByIdAndName","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"getUserByIdAndName","ruleName":"/brpc/getUserByIdAndName","parameterTypes":"java.lang.Long,java.lang.String","rpcExt":"{\"methodInfo\":[{\"methodName\":\"getUserByIdAndName\",\
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-18]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/connect","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"connect","ruleName":"/brpc/connect","rpcExt":"{\"methodInfo\":[{\"methodName\":\"connect\",\"paramTypes\":[]}]}","enabled":true,"host":"127.0.0.1","port":8005,"pluginNames":[],"registerMe
[...]
+2023-01-11 23:09:37.612 INFO 96741 --- [or_consumer_-22]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/getUser","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"getUser","ruleName":"/brpc/getUser","parameterTypes":"java.lang.Long","rpcExt":"{\"methodInfo\":[{\"methodName\":\"getUser\",\"paramTypes\":[{\"left\":\"java.lang.Long\",\"right\":\"userI
[...]
+
+```
+
+## Test
+
+The `shenyu-examples-brpc` project will automatically register interface
methods annotated with `@ShenyuBrpcClient` in the Apache ShenYu gateway after
successful startup.
+
+
+Open PluginList -> rpc proxy -> brpc to see the list of plugin rule
configurations:
+
+
+<img src="/img/shenyu/quick-start/brpc/rule-list.png" width="100%"
height="100%" />
+
+Use IDEA HTTP Client Plugin to simulate HTTP to request your Brpc
service[Shenyu proxy]:
+
+
diff --git a/docs/user-guide/brpc-proxy.md b/docs/user-guide/brpc-proxy.md
new file mode 100644
index 00000000000..69b33bea413
--- /dev/null
+++ b/docs/user-guide/brpc-proxy.md
@@ -0,0 +1,99 @@
+---
+title: Brpc Proxy
+description: Brpc Proxy
+---
+
+This document is intended to help the `Brpc` service access the `Apache
ShenYu` gateway. The `Apache ShenYu` gateway uses the `Brpc` plugin to handle
`Brpc` service.
+
+Before the connection, start `shenyu-admin` correctly, start `Brpc` plugin,
and add related dependencies on the gateway and `Brpc` application client.
Refer to the previous [Quick start with Brpc](../quick-start/quick-start-brpc) .
+
+For details about client access configuration, see [Application Client Access
Config](property-config/register-center-access.md) .
+
+For details about data synchronization configurations, see [Data
Synchronization Config](property-config/use-data-sync.md) .
+
+## Add Brpc plugin in gateway
+
+Add the following dependencies to the gateway's `pom.xml` file:
+
+
+```xml
+ <!-- apache shenyu brpc plugin -->
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-brpc</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+```
+
+* Restart your gateway service.
+
+## Brpc service access gateway
+
+Please refer to:
[shenyu-examples-brpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc)
+
+1. In the microservice built by `Brpc`, add the following dependencies:
+
+```xml
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-client-brpc</artifactId>
+ <version>${shenyu.version}</version>
+ </dependency>
+```
+
+2. Add the following configuration to the `application.yaml` configuration
file:
+
+```yaml
+server:
+ port: 8011
+ address: 0.0.0.0
+ servlet:
+ context-path: /
+spring:
+ main:
+ allow-bean-definition-overriding: true
+ application:
+ name: brpc-exmaples
+
+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:
+ brpc:
+ props:
+ contextPath: /brpc
+ ipAndPort: brpc
+ appName: brpc
+ port: 8005
+ host: 127.0.0.1
+
+# starlight
+starlight:
+ server:
+ enable: true
+ port: 8005
+```
+
+
+3. Add `@ShenyuBrpcClient` annotation to the method of `Brpc` service
interface implementation class, start your service provider, after successful
registration, go to PluginList -> rpc proxy -> brpc in the background
management system, you will see automatic registration of selectors and rules
information.
+
+Example:
+
+```java
+@ShenyuBrpcService
+public class BrpcDemoServiceImpl implements BrpcDemoService {
+ @Override
+ @ShenyuBrpcClient("/connect")
+ public void connect() {
+ LOG.info("Connect Success");
+ }
+}
+```
+
+## User Request
+
+You can request your `Brpc` service by Http. The `Apache ShenYu` gateway needs
to have a route prefix which is the `contextPath` configured by the access
gateway. For example: `http://localhost:9195/brpc/connect` .
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/brpc-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/brpc-plugin.md
new file mode 100644
index 00000000000..45fcb6f7828
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/proxy/brpc-plugin.md
@@ -0,0 +1,75 @@
+---
+title: Brpc插件
+keywords: ["Brpc"]
+description: Brpc插件
+---
+
+
+# 1. 概述
+
+## 1.1 插件名称
+
+* Brpc插件
+
+## 1.2 适用场景
+
+* 用来将`http协议` 转成 `Brpc协议`。
+
+## 1.3 插件代码
+
+* 核心模块 `shenyu-plugin-brpc`
+
+* 核心类 `org.apache.shenyu.plugin.brpc.BrpcPlugin`
+
+## 1.4 添加自哪个shenyu版本
+
+* Since ShenYu 2.5.1
+
+# 2. Brpc插件
+
+
+## 2.1 插件设置
+
+* 引入相关依赖，开启插件，请参考：[Brpc快速开始](../../quick-start/quick-start-brpc) 。
+
+* `Brpc`应用客户端接入，请参考：[Brpc服务接入](../../user-guide/brpc-proxy) 。
+
+
+## 2.2 元数据
+
+每一个`Brpc`接口方法，都会对应一条元数据，当`Brpc`应用客户端接入到`Apache ShenYu`网关时，会自动注册，可以在
`shenyu-admin`后台管理系统的基础配置 `-->` 元数据管理中查看。
+
+<img src="/img/shenyu/plugin/brpc/metadata.png" width="100%" height="100%" />
+
+* 应用名称：该条元数据所属的应用名称。
+
+* 方法名称：需要调用的方法名。
+
+* 路径：`Brpc`请求路径。
+
+* 路径描述：对该路径的说明，方便查看。
+
+* 参数类型：`Brpc`接口的参数类型列表，按照接口的参数类型顺序，通过半角逗号分隔。
+
+* Rpc扩展参数：描述了一个`Brpc`服务中每个接口信息。比如，下面是`Brpc`服务的接口信息：
+
+```json
+{
+ "methodInfo":[
+ {
+ "methodName":"getUser",
+ "paramTypes":[
+ {
+ "left":"java.lang.Long",
+ "right":"userId"
+ }
+ ]
+ }
+ ]
+}
+```
+
+
+* 服务接口：`Brpc`服务接口全限定名。
+
+* `Rpc`类型：下拉选择 `Brpc`。
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/quick-start/quick-start-brpc.md
b/i18n/zh/docusaurus-plugin-content-docs/current/quick-start/quick-start-brpc.md
new file mode 100644
index 00000000000..1faa6fcd4ad
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/current/quick-start/quick-start-brpc.md
@@ -0,0 +1,65 @@
+---
+title: Brpc快速开始
+description: Brpc快速开始
+---
+
+
+本文档演示如何将`Brpc`服务接入到`Apache
ShenYu`网关。您可以直接在工程下找到本文档的[示例代码](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc)
。
+
+## 环境准备
+
+请参考运维部署的内容，选择一种方式启动`shenyu-admin`。比如，通过 [本地部署](../deployment/deployment-local)
启动`Apache ShenYu`后台管理系统。
+
+启动成功后，需要在基础配置`->`插件管理中，把`brpc` 插件设置为开启。
+
+
+
+启动网关，如果是通过源码的方式，直接运行`shenyu-bootstrap`中的`ShenyuBootstrapApplication`。
+
+> 注意，在启动前，请确保网关已经引入相关依赖。
+
+引入网关对`Brpc`的代理插件，在网关的 `pom.xml` 文件中增加如下依赖：
+
+```xml
+ <!-- apache shenyu brpc plugin -->
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-brpc</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+```
+
+
+## 运行shenyu-examples-brpc项目
+
+下载
[shenyu-examples-brpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc)
。
+
+运行`org.apache.shenyu.examples.brpc.service.TestBrpcApplication`main方法启动项目。
+
+成功启动会有如下日志：
+
+```shell
+2023-01-11 23:09:37.593 INFO 96741 --- [or_consumer_-19]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/allName","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"allName","ruleName":"/brpc/allName","rpcExt":"{\"methodInfo\":[{\"methodName\":\"allName\",\"paramTypes\":[]}]}","enabled":true,"host":"127.0.0.1","port":8005,"pluginNames":[],"registerMe
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-21]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/userMap","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"userMap","ruleName":"/brpc/userMap","parameterTypes":"java.lang.Long","rpcExt":"{\"methodInfo\":[{\"methodName\":\"userMap\",\"paramTypes\":[{\"left\":\"java.lang.Long\",\"right\":\"userI
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-17]
o.a.s.r.client.http.utils.RegisterUtils : uri client register success:
{"appName":"brpc","contextPath":"/brpc","rpcType":"brpc","host":"127.0.0.1","port":8005}
+2023-01-11 23:09:37.612 INFO 96741 --- [or_consumer_-20]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/getUserByIdAndName","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"getUserByIdAndName","ruleName":"/brpc/getUserByIdAndName","parameterTypes":"java.lang.Long,java.lang.String","rpcExt":"{\"methodInfo\":[{\"methodName\":\"getUserByIdAndName\",\
[...]
+2023-01-11 23:09:37.611 INFO 96741 --- [or_consumer_-18]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/connect","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"connect","ruleName":"/brpc/connect","rpcExt":"{\"methodInfo\":[{\"methodName\":\"connect\",\"paramTypes\":[]}]}","enabled":true,"host":"127.0.0.1","port":8005,"pluginNames":[],"registerMe
[...]
+2023-01-11 23:09:37.612 INFO 96741 --- [or_consumer_-22]
o.a.s.r.client.http.utils.RegisterUtils : metadata client register success:
{"appName":"brpc","contextPath":"/brpc","path":"/brpc/getUser","rpcType":"brpc","serviceName":"org.apache.shenyu.examples.brpc.api.service.BrpcDemoService","methodName":"getUser","ruleName":"/brpc/getUser","parameterTypes":"java.lang.Long","rpcExt":"{\"methodInfo\":[{\"methodName\":\"getUser\",\"paramTypes\":[{\"left\":\"java.lang.Long\",\"right\":\"userI
[...]
+
+```
+
+
+
+## 测试Http请求
+
+`shenyu-examples-brpc`项目成功启动之后会自动把加 `@ShenyuBrpcClient`
注解的接口方法注册到网关，并添加选择器和规则，如果没有，可以手动添加。
+
+打开`插件列表 -> rpc proxy -> brpc`可以看到插件规则配置列表：
+
+
+
+使用 `IDEA HTTP Client` 插件模拟`http`的方式来请求你的`Brpc`服务[使用`shenyu`代理]:
+
+
+
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/brpc-proxy.md
b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/brpc-proxy.md
new file mode 100644
index 00000000000..341fe93bec9
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/brpc-proxy.md
@@ -0,0 +1,100 @@
+---
+title: Brpc服务接入
+description: Brpc服务接入
+---
+
+此篇文介绍如何将 `Brpc` 服务接入到 `Apache ShenYu` 网关，`Apache ShenYu` 网关使用 `Brpc`
插件来接入`Brpc`服务。
+
+接入前，请正确启动 `shenyu-admin`，并开启`Brpc`插件，在网关端和`Brpc`服务端引入相关依赖。可以参考前面的
[Brpc快速开始](../quick-start/quick-start-brpc) 。
+
+
+应用客户端接入的相关配置请参考：[客户端接入配置](property-config/register-center-access.md)。
+
+数据同步的相关配置请参考：[数据同步配置](property-config/use-data-sync.md)。
+
+## 在网关中引入 Brpc 插件
+
+
+引入网关对`Brpc`的代理插件，在网关的 `pom.xml` 文件中增加如下依赖：
+
+
+```xml
+ <!-- apache shenyu brpc plugin -->
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-brpc</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+```
+
+* 重启你的网关服务。
+
+## Brpc服务接入网关
+
+可以参考：
[shenyu-examples-brpc](https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-brpc)
+
+1. 在由`Brpc`构建的微服务中，引入如下依赖：
+
+```xml
+ <dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-client-brpc</artifactId>
+ <version>${shenyu.version}</version>
+ </dependency>
+```
+
+2. 在 `application.yaml` 配置文件增加如下配置：
+
+```yaml
+server:
+ port: 8011
+ address: 0.0.0.0
+ servlet:
+ context-path: /
+spring:
+ main:
+ allow-bean-definition-overriding: true
+ application:
+ name: brpc-exmaples
+
+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:
+ brpc:
+ props:
+ contextPath: /brpc
+ ipAndPort: brpc
+ appName: brpc
+ port: 8005
+ host: 127.0.0.1
+
+# starlight
+starlight:
+ server:
+ enable: true
+ port: 8005
+```
+
+3. 在`Brpc`服务接口实现类的方法上加上注解`@ShenyuBrpcClient`，启动你的服务提供者，成功注册后，在后台管理系统进入`插件列表 ->
rpc proxy -> brpc`，会看到自动注册的选择器和规则信息。
+
+示例：
+
+```java
+@ShenyuBrpcService
+public class BrpcDemoServiceImpl implements BrpcDemoService {
+ @Override
+ @ShenyuBrpcClient("/connect")
+ public void connect() {
+ LOG.info("Connect Success");
+ }
+}
+```
+
+## 用户请求
+
+可以通过 `http` 的方式来请求你的`Brpc`服务。`Apache ShenYu`网关需要有一个路由前缀，这个路由前缀就是接入网关配置的
`contextPath`。比如： `http://localhost:9195/brpc/connect` 。
diff --git a/static/img/shenyu/plugin/brpc/metadata.png
b/static/img/shenyu/plugin/brpc/metadata.png
new file mode 100644
index 00000000000..853a9c7f4cf
Binary files /dev/null and b/static/img/shenyu/plugin/brpc/metadata.png differ
diff --git a/static/img/shenyu/plugin/brpc/metadata_en.png
b/static/img/shenyu/plugin/brpc/metadata_en.png
new file mode 100644
index 00000000000..b04a71360ca
Binary files /dev/null and b/static/img/shenyu/plugin/brpc/metadata_en.png
differ
diff --git a/static/img/shenyu/quick-start/brpc/brpc_open.png
b/static/img/shenyu/quick-start/brpc/brpc_open.png
new file mode 100644
index 00000000000..0d0a7dbd9f9
Binary files /dev/null and b/static/img/shenyu/quick-start/brpc/brpc_open.png
differ
diff --git a/static/img/shenyu/quick-start/brpc/brpc_open_en.png
b/static/img/shenyu/quick-start/brpc/brpc_open_en.png
new file mode 100644
index 00000000000..b2c993593e9
Binary files /dev/null and
b/static/img/shenyu/quick-start/brpc/brpc_open_en.png differ
diff --git a/static/img/shenyu/quick-start/brpc/idea-http-test-brpc.png
b/static/img/shenyu/quick-start/brpc/idea-http-test-brpc.png
new file mode 100644
index 00000000000..136c057ece5
Binary files /dev/null and
b/static/img/shenyu/quick-start/brpc/idea-http-test-brpc.png differ
diff --git a/static/img/shenyu/quick-start/brpc/rule-list.png
b/static/img/shenyu/quick-start/brpc/rule-list.png
new file mode 100644
index 00000000000..d236ee9aec8
Binary files /dev/null and b/static/img/shenyu/quick-start/brpc/rule-list.png
differ
