You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by ga...@apache.org on 2022/10/09 02:24:46 UTC
[shenyu-website] branch main updated: add doc for dotnet client (#788)
This is an automated email from the ASF dual-hosted git repository.
gaohan 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 9b53941612 add doc for dotnet client (#788)
9b53941612 is described below
commit 9b53941612d9207271d1cbaec4d3a7a614b2c9b3
Author: Han Gao <dh...@hotmail.com>
AuthorDate: Sun Oct 9 10:24:41 2022 +0800
add doc for dotnet client (#788)
---
community/15-shenyu-client-dotnet-release-guide.md | 2 +-
docusaurus.config.js | 166 ++++++-----
i18n/zh/code.json | 324 +++++++++++----------
.../current/consul.md | 75 +++++
.../current/etcd.md | 77 +++++
.../current/http.md | 72 +++++
.../current/nacos.md | 79 +++++
.../current/zookeeper.md | 77 +++++
shenyuClientDotnet/consul.md | 80 +++++
shenyuClientDotnet/etcd.md | 82 ++++++
shenyuClientDotnet/http.md | 78 +++++
shenyuClientDotnet/nacos.md | 84 ++++++
shenyuClientDotnet/zookeeper.md | 82 ++++++
src/data/docsInfo.js | 82 ++++--
14 files changed, 1097 insertions(+), 263 deletions(-)
diff --git a/community/15-shenyu-client-dotnet-release-guide.md b/community/15-shenyu-client-dotnet-release-guide.md
index 83c3063a3b..ff2f2cf1d9 100644
--- a/community/15-shenyu-client-dotnet-release-guide.md
+++ b/community/15-shenyu-client-dotnet-release-guide.md
@@ -1,6 +1,6 @@
---
title: ShenYu client .NET Release Guide
-sidebar_position: 14
+sidebar_position: 15
description: Apache ShenYu-client-dotnet Release Guide
cover: "/img/architecture/shenyu-framework.png"
---
diff --git a/docusaurus.config.js b/docusaurus.config.js
index 4c14c757e2..0e9f1c9242 100755
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -1,60 +1,61 @@
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
- title: 'Apache ShenYu',
- tagline: 'Apache ShenYu - High-performance, multi-protocol, extensible, responsive API Gateway',
- url: 'https://shenyu.apache.org/',
- baseUrl: '/',
- onBrokenLinks: 'log',
- onBrokenMarkdownLinks: 'warn',
- favicon: 'img/favicon.svg',
- organizationName: 'apache', // Usually your GitHub org/user name.
- projectName: 'shenyu', // Usually your repo name.
+ title: "Apache ShenYu",
+ tagline:
+ "Apache ShenYu - High-performance, multi-protocol, extensible, responsive API Gateway",
+ url: "https://shenyu.apache.org/",
+ baseUrl: "/",
+ onBrokenLinks: "log",
+ onBrokenMarkdownLinks: "warn",
+ favicon: "img/favicon.svg",
+ organizationName: "apache", // Usually your GitHub org/user name.
+ projectName: "shenyu", // Usually your repo name.
i18n: {
defaultLocale: "en",
locales: ["en", "zh"],
localeConfigs: {
en: {
label: "English",
- direction: 'ltr',
+ direction: "ltr",
},
zh: {
label: "简体中文",
- direction: 'ltr',
+ direction: "ltr",
},
},
},
themeConfig: {
navbar: {
logo: {
- alt: 'Apache ShenYu Logo',
- src: 'img/logo.svg',
- srcDark: 'img/logo-light.svg'
+ alt: "Apache ShenYu Logo",
+ src: "img/logo.svg",
+ srcDark: "img/logo-light.svg",
},
items: [
- {to: '/download', label: 'Download', position: 'right'},
- {to: '/document', label: 'Docs', position: 'right'},
+ { to: "/download", label: "Download", position: "right" },
+ { to: "/document", label: "Docs", position: "right" },
{
- to: '/community/contributor-guide',
- label: 'Community',
- position: 'right',
+ to: "/community/contributor-guide",
+ label: "Community",
+ position: "right",
activeBaseRegex: `/community/`,
},
- {to: '/team', label: 'Team', position: 'right'},
+ { to: "/team", label: "Team", position: "right" },
{
- label: 'Event',
- position: 'right',
- to: '/event',
+ label: "Event",
+ position: "right",
+ to: "/event",
activeBaseRegex: `/event/`,
},
- {to: '/news', label: 'News', position: 'right'},
- {to: '/blog', label: 'Blog', position: 'right'},
- {to: '/users', label: 'Users', position: 'right'},
+ { to: "/news", label: "News", position: "right" },
+ { to: "/blog", label: "Blog", position: "right" },
+ { to: "/users", label: "Users", position: "right" },
{
- label: 'ASF',
- position: 'right',
+ label: "ASF",
+ position: "right",
items: [
{
label: "Foundation",
@@ -87,9 +88,9 @@ module.exports = {
],
},
{
- href: 'https://github.com/apache/shenyu',
- label: 'GitHub',
- position: 'right',
+ href: "https://github.com/apache/shenyu",
+ label: "GitHub",
+ position: "right",
},
{
type: "localeDropdown",
@@ -100,97 +101,118 @@ module.exports = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
- additionalLanguages: ['java', 'properties', 'nginx', 'http', 'lua', 'json5', 'protobuf'],
+ additionalLanguages: [
+ "java",
+ "properties",
+ "nginx",
+ "http",
+ "lua",
+ "json5",
+ "protobuf",
+ ],
},
algolia: {
- apiKey: '5f882bef2dfc81f5f1b4e5ea87b2f165',
- indexName: 'apache_shenyu',
+ apiKey: "5f882bef2dfc81f5f1b4e5ea87b2f165",
+ indexName: "apache_shenyu",
// Optional: see doc section below
contextualSearch: true,
},
},
presets: [
[
- '@docusaurus/preset-classic',
+ "@docusaurus/preset-classic",
{
docs: {
- sidebarPath: require.resolve('./sidebars.js'),
+ sidebarPath: require.resolve("./sidebars.js"),
editLocalizedFiles: true,
// Please change this to your repo.
- editUrl:
- 'https://github.com/apache/shenyu-website/edit/main/',
+ editUrl: "https://github.com/apache/shenyu-website/edit/main/",
},
blog: {
showReadingTime: true,
blogSidebarCount: 0,
- blogSidebarTitle: 'All Blog Posts',
+ blogSidebarTitle: "All Blog Posts",
editLocalizedFiles: true,
// Please change this to your repo.
- editUrl:
- 'https://github.com/apache/shenyu-website/edit/main/',
+ editUrl: "https://github.com/apache/shenyu-website/edit/main/",
},
theme: {
- customCss: require.resolve('./src/css/custom.css'),
+ customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
plugins: [
[
- '@docusaurus/plugin-content-docs',
+ "@docusaurus/plugin-content-docs",
{
- id: 'community',
- path: 'community',
- routeBasePath: 'community',
- editUrl: ({locale, versionDocsDirPath, docPath}) => {
- if (locale !== 'en') {
+ id: "community",
+ path: "community",
+ routeBasePath: "community",
+ editUrl: ({ locale, versionDocsDirPath, docPath }) => {
+ if (locale !== "en") {
return `https://github.com/apache/shenyu-website/edit/main/i18n/${locale}/docusaurus-plugin-content-docs-community/current/${docPath}`;
}
return `https://github.com/apache/shenyu-website/edit/main/${versionDocsDirPath}/${docPath}`;
},
editCurrentVersion: true,
editLocalizedFiles: true,
- sidebarPath: require.resolve('./sidebarsCommunity.js'),
+ sidebarPath: require.resolve("./sidebarsCommunity.js"),
showLastUpdateAuthor: true,
showLastUpdateTime: true,
},
],
[
- '@docusaurus/plugin-content-docs',
+ "@docusaurus/plugin-content-docs",
{
- id: 'shenyuNginx',
- path: 'shenyuNginx',
- routeBasePath: 'shenyuNginx',
+ id: "shenyuNginx",
+ path: "shenyuNginx",
+ routeBasePath: "shenyuNginx",
editCurrentVersion: true,
editLocalizedFiles: true,
- sidebarPath: require.resolve('./sidebarsCommunity.js'),
+ sidebarPath: require.resolve("./sidebarsCommunity.js"),
showLastUpdateAuthor: true,
showLastUpdateTime: true,
- }
+ },
],
[
- '@docusaurus/plugin-content-docs',
+ "@docusaurus/plugin-content-docs",
{
- id: 'shenyuClientGolang',
- path: 'shenyuClientGolang',
- routeBasePath: 'shenyuClientGolang',
+ id: "shenyuClientGolang",
+ path: "shenyuClientGolang",
+ routeBasePath: "shenyuClientGolang",
disableVersioning: false,
includeCurrentVersion: true,
editCurrentVersion: true,
editLocalizedFiles: true,
- sidebarPath: require.resolve('./sidebarsCommunity.js'),
+ sidebarPath: require.resolve("./sidebarsCommunity.js"),
showLastUpdateAuthor: true,
showLastUpdateTime: true,
- }
+ },
],
[
- '@docusaurus/plugin-content-docs',
+ "@docusaurus/plugin-content-docs",
{
- id: 'event',
- path: 'event',
- routeBasePath: 'event',
- editUrl: ({locale, versionDocsDirPath, docPath}) => {
- if (locale !== 'en') {
+ id: "shenyuClientDotnet",
+ path: "shenyuClientDotnet",
+ routeBasePath: "shenyuClientDotnet",
+ disableVersioning: false,
+ includeCurrentVersion: true,
+ editCurrentVersion: true,
+ editLocalizedFiles: true,
+ sidebarPath: require.resolve("./sidebarsCommunity.js"),
+ showLastUpdateAuthor: true,
+ showLastUpdateTime: true,
+ },
+ ],
+ [
+ "@docusaurus/plugin-content-docs",
+ {
+ id: "event",
+ path: "event",
+ routeBasePath: "event",
+ editUrl: ({ locale, versionDocsDirPath, docPath }) => {
+ if (locale !== "en") {
return `https://github.com/apache/shenyu-website/edit/main/i18n/${locale}/docusaurus-plugin-content-docs-event/current/${docPath}`;
}
return `https://github.com/apache/shenyu-website/edit/main/${versionDocsDirPath}/${docPath}`;
@@ -200,7 +222,7 @@ module.exports = {
sidebarPath: false,
showLastUpdateAuthor: true,
showLastUpdateTime: true,
- }
+ },
],
[
"@docusaurus/plugin-content-blog",
@@ -208,8 +230,8 @@ module.exports = {
id: "news",
routeBasePath: "news",
path: "news",
- blogSidebarCount:0,
+ blogSidebarCount: 0,
},
],
- ]
+ ],
};
diff --git a/i18n/zh/code.json b/i18n/zh/code.json
index fbdeeca8ef..1db2ab7b66 100755
--- a/i18n/zh/code.json
+++ b/i18n/zh/code.json
@@ -289,269 +289,275 @@
"[Here].": {
"message": "[这里]。"
},
- "Recent Posts":{
- "message":"近期新闻"
+ "Recent Posts": {
+ "message": "近期新闻"
},
- "Read More":{
- "message":"阅读更多"
+ "Read More": {
+ "message": "阅读更多"
},
- "SPI Source Code Analysis":{
- "message":"SPI设计实现源码分析"
+ "SPI Source Code Analysis": {
+ "message": "SPI设计实现源码分析"
},
- "Recently,when I read the source code of open source project Apache Shenyu API gateway,I find and many core components of the gateway are loaded with the SPI module. Here I will analyzes the source code of SPI module in Shenyu gateway.":{
- "message":"最近研读Apache开源项目Shenyu网关的源码,网关的多个核心组件加载都用到了SPI模块。本文就Shenyu中的SPI设计和源码实现进行分析。"
+ "Recently,when I read the source code of open source project Apache Shenyu API gateway,I find and many core components of the gateway are loaded with the SPI module. Here I will analyzes the source code of SPI module in Shenyu gateway.": {
+ "message": "最近研读Apache开源项目Shenyu网关的源码,网关的多个核心组件加载都用到了SPI模块。本文就Shenyu中的SPI设计和源码实现进行分析。"
},
- "MatchStrategy -- analyze the design based on SPI":{
- "message":"MatchStrategy--基于SPI的代码分析"
+ "MatchStrategy -- analyze the design based on SPI": {
+ "message": "MatchStrategy--基于SPI的代码分析"
},
- "Gateway applications need to support a variety of load balancing strategies, including random,Hashing, RoundRobin and so on. In Apache Shenyu gateway, it not only realizes such traditional algorithms, but also makes smoother traffic processing for the entry of server nodes through detailed processing such as traffic warm-up, so as to obtain better overall stability. In this article, let's walk through how Apache Shenyu is designed and implemented this part of the function.":{
- "message":"Apache Shenyu 网关的各个Plugin(包括Dubbo, gRPC,Spring-cloud等) 中,routing参数均设计为可以接受多个条件的组合。 为了实现这样的目的,遵循其SPI的机制进行将参数及行为抽象为如下三部分,这些SPI 在shenyu-plugin-base模组中实现。"
+ "Gateway applications need to support a variety of load balancing strategies, including random,Hashing, RoundRobin and so on. In Apache Shenyu gateway, it not only realizes such traditional algorithms, but also makes smoother traffic processing for the entry of server nodes through detailed processing such as traffic warm-up, so as to obtain better overall stability. In this article, let's walk through how Apache Shenyu is designed and implemented this part of the function.": {
+ "message": "Apache Shenyu 网关的各个Plugin(包括Dubbo, gRPC,Spring-cloud等) 中,routing参数均设计为可以接受多个条件的组合。 为了实现这样的目的,遵循其SPI的机制进行将参数及行为抽象为如下三部分,这些SPI 在shenyu-plugin-base模组中实现。"
},
- "PredicateJudge -- analyze the design based on SPI":{
- "message":"PredicateJudge-- 基于SPI的设计实现分析"
+ "PredicateJudge -- analyze the design based on SPI": {
+ "message": "PredicateJudge-- 基于SPI的设计实现分析"
},
- "In most of the plugins ( such as Dubbo, gRPC,Spring-cloud, etc) of Apache Shenyu, the routingparameters are designed to support the combination of multiple conditions. In order to realize such requirements, the parameters and behaviors are abstracted to three parts according to its SPI mechanism, and implemented in shenyu-plugin-base module.":{
- "message":"灵活的插件和规则定义,是Shenyu网关的一大特色。它以插件形式支持多种网络协议和多种流行的微服务框架,如Dubbo, gRPC和 Spring-Cloud 等。 为了实现对各种协议及插件的配置规则的解析,网关在规则策略解析方面,采用了优雅的SPI(Service Provider Interface)实现,当添加新的插件时,规则解析部分可以沿用现有实现或采用SPI机制快速实现,具有良好的可扩展性。"
+ "In most of the plugins ( such as Dubbo, gRPC,Spring-cloud, etc) of Apache Shenyu, the routingparameters are designed to support the combination of multiple conditions. In order to realize such requirements, the parameters and behaviors are abstracted to three parts according to its SPI mechanism, and implemented in shenyu-plugin-base module.": {
+ "message": "灵活的插件和规则定义,是Shenyu网关的一大特色。它以插件形式支持多种网络协议和多种流行的微服务框架,如Dubbo, gRPC和 Spring-Cloud 等。 为了实现对各种协议及插件的配置规则的解析,网关在规则策略解析方面,采用了优雅的SPI(Service Provider Interface)实现,当添加新的插件时,规则解析部分可以沿用现有实现或采用SPI机制快速实现,具有良好的可扩展性。"
},
- "LoadBalance SPI Source Code Analysis":{
- "message":"LoadBalance SPI 代码分析"
+ "LoadBalance SPI Source Code Analysis": {
+ "message": "LoadBalance SPI 代码分析"
},
- "Apache Shenyu has been identified as a gateway application which supports a variety of protocols and microservice frameworks such as Dubbo, gRPC, Spring-Cloud, etc. To do this, the product has accomplished an elegant SPI (Service Provider Interface) as its foundation, and make the Rule data parsing and predicting program very simple , resiliency and security. As to rule data parsing processing, the SPI design increases the product's scalability. When appending new plugin, in most case [...]
- "message":"网关应用需要支持多种负载均衡的方案,包括随机选择、Hash、轮询等方式。Apache Shenyu网关中不仅实现了传统网关的这些均衡策略,还通过流量预热(warmup)等细节处理,对服务器节点的加入,做了更平滑的流量处理,获得了更好的整体稳定性。让我们来看看Shenyu是是如何设计和实现这部分功能的。"
+ "Apache Shenyu has been identified as a gateway application which supports a variety of protocols and microservice frameworks such as Dubbo, gRPC, Spring-Cloud, etc. To do this, the product has accomplished an elegant SPI (Service Provider Interface) as its foundation, and make the Rule data parsing and predicting program very simple , resiliency and security. As to rule data parsing processing, the SPI design increases the product's scalability. When appending new plugin, in most case [...]
+ "message": "网关应用需要支持多种负载均衡的方案,包括随机选择、Hash、轮询等方式。Apache Shenyu网关中不仅实现了传统网关的这些均衡策略,还通过流量预热(warmup)等细节处理,对服务器节点的加入,做了更平滑的流量处理,获得了更好的整体稳定性。让我们来看看Shenyu是是如何设计和实现这部分功能的。"
},
- "RateLimiter SPI code analysis":{
- "message":"RateLimiter SPI 代码分析"
+ "RateLimiter SPI code analysis": {
+ "message": "RateLimiter SPI 代码分析"
},
- "Rate limiter is a very important integral of gateway application, to deal with high traffic. When the system is attacked abnormally by a large number of traffic gathered in a short time; When there are a large number of lower priority request need to be slow down or else it will effect your high priority transactions; Or sometimes your system can not afford the regular traffic; in these scenarios, we need to start rate limiter component to protect our system, through rejection, wait, [...]
- "message":"限流是网关必备的功能,用来应对高并发请求的场景。当系统受到异常攻击,短期内聚集了大量的流量;当有大量低级别的请求,处理这些请求会影响关键业务的处理,需要限制这些请求的访问速度; 或者系统内部出现一些异常,不能满负荷的服务整个应用请求等等。这些情况下,都需要启用限流来保护系统。可以拒绝服务、等待或降级处理,将流量限制到系统可接受的量,或者只允许某些域名(或某些业务)的请求优先处理。"
+ "Rate limiter is a very important integral of gateway application, to deal with high traffic. When the system is attacked abnormally by a large number of traffic gathered in a short time; When there are a large number of lower priority request need to be slow down or else it will effect your high priority transactions; Or sometimes your system can not afford the regular traffic; in these scenarios, we need to start rate limiter component to protect our system, through rejection, wait, [...]
+ "message": "限流是网关必备的功能,用来应对高并发请求的场景。当系统受到异常攻击,短期内聚集了大量的流量;当有大量低级别的请求,处理这些请求会影响关键业务的处理,需要限制这些请求的访问速度; 或者系统内部出现一些异常,不能满负荷的服务整个应用请求等等。这些情况下,都需要启用限流来保护系统。可以拒绝服务、等待或降级处理,将流量限制到系统可接受的量,或者只允许某些域名(或某些业务)的请求优先处理。"
},
- "Register Center Source Code Analysis of Http Register":{
- "message":"注册中心实现原理之Http注册"
+ "Register Center Source Code Analysis of Http Register": {
+ "message": "注册中心实现原理之Http注册"
},
- "In ShenYu gateway, the registration center is used to register the client information to shenyu-admin, admin then synchronizes this information to the gateway through data synchronization, and the gateway completes traffic filtering through these data. The client information mainly includes interface information and URI information.":{
- "message":"在ShenYu网关中,注册中心是用于将客户端信息注册到shenyu-admin,admin再通过数据同步将这些信息同步到网关,网关通过这些数据完成流量筛选。客户端信息主要包括接口信息和URI信息。"
+ "In ShenYu gateway, the registration center is used to register the client information to shenyu-admin, admin then synchronizes this information to the gateway through data synchronization, and the gateway completes traffic filtering through these data. The client information mainly includes interface information and URI information.": {
+ "message": "在ShenYu网关中,注册中心是用于将客户端信息注册到shenyu-admin,admin再通过数据同步将这些信息同步到网关,网关通过这些数据完成流量筛选。客户端信息主要包括接口信息和URI信息。"
},
- "Apache ShenYu Start Demo":{
- "message":"Apache ShenYu 启动示例"
+ "Apache ShenYu Start Demo": {
+ "message": "Apache ShenYu 启动示例"
},
- "Etcd Data Synchronization Source Code Analysis":{
- "message":"Etcd数据同步源码分析"
+ "Etcd Data Synchronization Source Code Analysis": {
+ "message": "Etcd数据同步源码分析"
},
- "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, Etcd and Consul. The main content of this article is based on Etcd data synchronization source code analysis.":{
- "message":"在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Etcd的数据同步源码分析。"
+ "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, Etcd and Consul. The main content of this article is based on Etcd data synchronization source code analysis.": {
+ "message": "在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Etcd的数据同步源码分析。"
},
- "Http Long Polling Data Synchronization Source Code Analysis":{
- "message":"Http长轮询数据同步源码分析"
+ "Http Long Polling Data Synchronization Source Code Analysis": {
+ "message": "Http长轮询数据同步源码分析"
},
- "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on http long poll data synchronization source code analysis.":{
- "message":"在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Http长轮询的数据同步源码分析。"
+ "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on http long poll data synchronization source code analysis.": {
+ "message": "在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Http长轮询的数据同步源码分析。"
},
- "Nacos Data Synchronization Source Code Analysis":{
- "message":"Nacos数据同步源码分析"
+ "Nacos Data Synchronization Source Code Analysis": {
+ "message": "Nacos数据同步源码分析"
},
- "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on Nacos data synchronization source code analysis.":{
- "message":"在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Nacos的数据同步源码分析。"
+ "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on Nacos data synchronization source code analysis.": {
+ "message": "在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、Etcd 和 Consul 进行数据同步。本文的主要内容是基于Nacos的数据同步源码分析。"
},
- "WebSocket Data Synchronization Source Code Analysis":{
- "message":"WebSocket数据同步源码分析"
+ "WebSocket Data Synchronization Source Code Analysis": {
+ "message": "WebSocket数据同步源码分析"
},
- "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on WebSocket data synchronization source code analysis.":{
- "message":"在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、etcd 和 Consul 进行数据同步。本文的主要内容是基于WebSocket的数据同步源码分析。"
+ "In ShenYu gateway, data synchronization refers to how to synchronize the updated data to the gateway after the data is sent in the background management system. The Apache ShenYu gateway currently supports data synchronization for ZooKeeper, WebSocket, http long poll, Nacos, etcd and Consul. The main content of this article is based on WebSocket data synchronization source code analysis.": {
+ "message": "在ShenYu网关中,数据同步是指,当在后台管理系统中,数据发送了更新后,如何将更新的数据同步到网关中。Apache ShenYu 网关当前支持ZooKeeper、WebSocket、Http长轮询、Nacos 、etcd 和 Consul 进行数据同步。本文的主要内容是基于WebSocket的数据同步源码分析。"
},
- "ZooKeeper Data Synchronization Source Code Analysis":{
- "message":"ZooKeeper数据同步源码分析"
+ "ZooKeeper Data Synchronization Source Code Analysis": {
+ "message": "ZooKeeper数据同步源码分析"
},
- "Integration Test Analysis":{
- "message":"集成剖析测试"
+ "Integration Test Analysis": {
+ "message": "集成剖析测试"
},
- "This article will provide an in-depth analysis of Apache ShenYu's integration tests.":{
- "message":"这篇文章将会对Apache ShenYu的集成测试进行深入剖析。"
+ "This article will provide an in-depth analysis of Apache ShenYu's integration tests.": {
+ "message": "这篇文章将会对Apache ShenYu的集成测试进行深入剖析。"
},
- "Code Analysis For Context-Path Plugin":{
- "message":"Context-Path插件源码分析"
+ "Code Analysis For Context-Path Plugin": {
+ "message": "Context-Path插件源码分析"
},
- "Code Analysis For Dubbo Plugin":{
- "message":"Dubbo Plugin插件源码分析"
+ "Code Analysis For Dubbo Plugin": {
+ "message": "Dubbo Plugin插件源码分析"
},
- "The ShenYu gateway uses the divide plugin to handle http requests. You can see the official documentation Quick start with Http to learn how to use this plugin.":{
- "message":"Apache ShenYu 网关使用 dubbo 插件完成对 dubbo服务的调用。你可以查看官方文档 Dubbo快速开始 了解如何使用该插件。"
+ "The ShenYu gateway uses the divide plugin to handle http requests. You can see the official documentation Quick start with Http to learn how to use this plugin.": {
+ "message": "Apache ShenYu 网关使用 dubbo 插件完成对 dubbo服务的调用。你可以查看官方文档 Dubbo快速开始 了解如何使用该插件。"
},
- "Code Analysis For Param-Mapping Plugin":{
- "message":"Param-Mapping插件源码分析"
+ "Code Analysis For Param-Mapping Plugin": {
+ "message": "Param-Mapping插件源码分析"
},
- "The Apache ShenYu gateway uses the dubbo plugin to make calls to the dubbo service. You can see the official documentation Dubbo Quick Start to learn how to use the plugin.":{
- "message":"Apache ShenYu 网关使用 dubbo 插件完成对 dubbo服务的调用。你可以查看官方文档 Dubbo快速开始 了解如何使用该插件。"
+ "The Apache ShenYu gateway uses the dubbo plugin to make calls to the dubbo service. You can see the official documentation Dubbo Quick Start to learn how to use the plugin.": {
+ "message": "Apache ShenYu 网关使用 dubbo 插件完成对 dubbo服务的调用。你可以查看官方文档 Dubbo快速开始 了解如何使用该插件。"
},
- "Code Analysis For Divide Plugin":{
- "message":"Divide插件源码分析"
+ "Code Analysis For Divide Plugin": {
+ "message": "Divide插件源码分析"
},
- "From company gateway framework selection to Apache ShenYu Committer":{
- "message":"从公司网关选型到Apache ShenYu Committer"
+ "From company gateway framework selection to Apache ShenYu Committer": {
+ "message": "从公司网关选型到Apache ShenYu Committer"
},
"From Apache ShenYu User to Apache ShenYu Committer": {
"message": "从用户到Apache ShenYu Committer"
},
- "From CRUD Boy to Apache ShenYu Committer":{
- "message":"从CRUD Boy到Apache ShenYu Committer"
+ "From CRUD Boy to Apache ShenYu Committer": {
+ "message": "从CRUD Boy到Apache ShenYu Committer"
},
- "You can also be an Apache ShenYu Committer":{
- "message":"你也可以成为Apache ShenYu Committer"
+ "You can also be an Apache ShenYu Committer": {
+ "message": "你也可以成为Apache ShenYu Committer"
},
- "Apache ShenYu 2.4.3 Version Release":{
- "message":"Apache ShenYu 2.4.3 版本发布"
+ "Apache ShenYu 2.4.3 Version Release": {
+ "message": "Apache ShenYu 2.4.3 版本发布"
},
- "The way from University Student to Apache Committer":{
- "message":"从在校生到Apache Committer之路"
+ "The way from University Student to Apache Committer": {
+ "message": "从在校生到Apache Committer之路"
},
- "From users to Committer, different experiences and gains":{
- "message":"从用户到Committer,别样体验和收获"
+ "From users to Committer, different experiences and gains": {
+ "message": "从用户到Committer,别样体验和收获"
},
- "Apache ShenYu newly promoted PPMC":{
- "message":"Apache ShenYu 新晋PPMC"
+ "Apache ShenYu newly promoted PPMC": {
+ "message": "Apache ShenYu 新晋PPMC"
},
- "From users to Committer, participation in the Apache ShenYu community is not far away":{
- "message":"从用户到Committer,参与Apache ShenYu社区并不遥远"
+ "From users to Committer, participation in the Apache ShenYu community is not far away": {
+ "message": "从用户到Committer,参与Apache ShenYu社区并不遥远"
},
- "Release the first version of Apache ShenYu 2.4.0 Make API gateway easy":{
- "message":"发布Apache首个版本-2.4.0 让API网关变得简单"
+ "Release the first version of Apache ShenYu 2.4.0 Make API gateway easy": {
+ "message": "发布Apache首个版本-2.4.0 让API网关变得简单"
},
- "How I became an Apache ShenYu Committer one year after graduation":{
- "message":"毕业一年我是如何成为Apache ShenYu Committer"
+ "How I became an Apache ShenYu Committer one year after graduation": {
+ "message": "毕业一年我是如何成为Apache ShenYu Committer"
},
- "The Open Source Path for Tech Veterans":{
- "message":"技术老兵的开源之路"
+ "The Open Source Path for Tech Veterans": {
+ "message": "技术老兵的开源之路"
},
- "Soul gateway release milestone version 2.3.0 New support for grpc, tars and sofa protocols":{
- "message":"[Soul 网关发布里程碑的2.3.0版本] 新增支持GRPC,Tars,Sofa协议"
+ "Soul gateway release milestone version 2.3.0 New support for grpc, tars and sofa protocols": {
+ "message": "[Soul 网关发布里程碑的2.3.0版本] 新增支持GRPC,Tars,Sofa协议"
},
- "Version List":{
- "message":"版本列表"
+ "Version List": {
+ "message": "版本列表"
},
- "Release Apache Shenyu 2.4.3":{
- "message":"Apache Shenyu 2.4.3 发布"
+ "Release Apache Shenyu 2.4.3": {
+ "message": "Apache Shenyu 2.4.3 发布"
},
- "Release Apache Shenyu 2.4.2":{
- "message":"Apache Shenyu 2.4.2 发布"
+ "Release Apache Shenyu 2.4.2": {
+ "message": "Apache Shenyu 2.4.2 发布"
},
- "Release Apache Shenyu 2.4.1":{
- "message":"Apache Shenyu 2.4.1 发布"
+ "Release Apache Shenyu 2.4.1": {
+ "message": "Apache Shenyu 2.4.1 发布"
},
- "Release Apache Shenyu 2.4.0":{
- "message":"Apache Shenyu 2.4.0 发布"
+ "Release Apache Shenyu 2.4.0": {
+ "message": "Apache Shenyu 2.4.0 发布"
},
- "Release Apache Shenyu 2.3.0":{
- "message":"Apache Shenyu 2.3.0 发布"
+ "Release Apache Shenyu 2.3.0": {
+ "message": "Apache Shenyu 2.3.0 发布"
},
- "Release Apache Shenyu 2.2.0":{
- "message":"Apache Shenyu 2.2.0 发布"
+ "Release Apache Shenyu 2.2.0": {
+ "message": "Apache Shenyu 2.2.0 发布"
},
"Release Apache Shenyu 2.5.0": {
- "message":"Apache Shenyu 2.5.0 发布"
+ "message": "Apache Shenyu 2.5.0 发布"
},
- "Events":{
- "message":"事件"
+ "Events": {
+ "message": "事件"
},
- "Download":{
- "message":"下载"
+ "Download": {
+ "message": "下载"
},
- "Document":{
- "message":"文档"
+ "Document": {
+ "message": "文档"
},
- "News":{
- "message":"新闻"
+ "News": {
+ "message": "新闻"
},
- "Release":{
- "message":"发布"
+ "Release": {
+ "message": "发布"
},
- "Community":{
- "message":"社区"
+ "Community": {
+ "message": "社区"
},
- "Subscribe mailing list":{
- "message":"邮件订阅组"
+ "Subscribe mailing list": {
+ "message": "邮件订阅组"
},
- "How to subscribe":{
- "message":"如何订阅"
+ "How to subscribe": {
+ "message": "如何订阅"
},
- "Subscribe Mail":{
- "message":"订阅邮件"
+ "Subscribe Mail": {
+ "message": "订阅邮件"
},
- "Mail Archive":{
- "message":"邮件归档"
+ "Mail Archive": {
+ "message": "邮件归档"
},
- "Proxy":{
- "message":"服务代理"
+ "Proxy": {
+ "message": "服务代理"
},
- "Security":{
- "message":"安全性"
+ "Security": {
+ "message": "安全性"
},
- "API governance":{
- "message":"API 治理"
+ "API governance": {
+ "message": "API 治理"
},
- "Observability":{
- "message":"可观测性"
+ "Observability": {
+ "message": "可观测性"
},
- "Dashboard":{
- "message":"控制面板"
+ "Dashboard": {
+ "message": "控制面板"
},
- "Extensions":{
- "message":"拓展"
+ "Extensions": {
+ "message": "拓展"
},
- "Cluster":{
- "message":"集群"
+ "Cluster": {
+ "message": "集群"
},
- "Language":{
- "message":"语言"
+ "Language": {
+ "message": "语言"
},
- "Source Codes":{
- "message":"源码"
+ "Source Codes": {
+ "message": "源码"
},
- "Source":{
- "message":"源码"
+ "Source": {
+ "message": "源码"
},
- "ShenYu-Admin Binary Distribution":{
+ "ShenYu-Admin Binary Distribution": {
"message": "ShenYu-Admin 二进制包"
},
- "ShenYu-Bootstrap Binary Distribution":{
+ "ShenYu-Bootstrap Binary Distribution": {
"message": "ShenYu-Bootstrap 二进制包"
},
- "Document List":{
+ "Document List": {
"message": "文档列表"
},
- "This directory presents the official Apache ShenYu repositories and some ecosystem projects developed by community.":{
+ "This directory presents the official Apache ShenYu repositories and some ecosystem projects developed by community.": {
"message": "本页面展示了Apache ShenYu及其生态项目的使用文档。"
},
- "The downloadable releases can be find in the":{
+ "The downloadable releases can be find in the": {
"message": "可下载的已发布版本下载地址:"
},
- "download page":{
+ "download page": {
"message": "下载地址"
},
- "Apache ShenYu Docs":{
+ "Apache ShenYu Docs": {
"message": "Apache ShenYu 文档"
},
- "ShenYu Nginx Docs":{
+ "ShenYu Nginx Docs": {
"message": "ShenYu Nginx 文档"
},
- "Shenyu-client-golang Docs":{
+ "Shenyu-client-golang Docs": {
"message": "Shenyu-client-golang 文档"
},
- "The document for Apache ShenYu":{
+ "ShenYu .NET Client Docs": {
+ "message": "ShenYu .NET 客户端文档"
+ },
+ "The document for Apache ShenYu": {
"message": "Apache ShenYu官方文档"
},
- "This module provided SDK to watch available ShenYu instance list as upstream nodes by Service Register Center for OpenResty.":{
+ "This module provided SDK to watch available ShenYu instance list as upstream nodes by Service Register Center for OpenResty.": {
"message": "该模块提供了SDK来监视OpenResty的服务注册中心作为上游节点的可用ShenYu实例列表"
},
- "Shenyu-client-golang for Go client allows you to access ShenYu Gateway,it supports registory go service to ShenYu Gateway.":{
+ "Shenyu-client-golang for Go client allows you to access ShenYu Gateway,it supports registory go service to ShenYu Gateway.": {
"message": "Shenyu-client-golang是提供了Go语言访问ShenYu网关的功能,并支持服务注册到ShenYu网关。"
},
- "All Versions":{
+ "ShenYu .NET client allows you to register your Apps to ShenYu Gateway automatically and use ShenYu as gateway easily.": {
+ "message": "ShenYu .NET 客户端可以帮助自动将你的 Apps 注册到 ShenYu 网关,从而更加方便的使用 ShenYu。"
+ },
+ "All Versions": {
"message": "所有版本"
},
- "Latest Version":{
+ "Latest Version": {
"message": "最新版本"
},
- "Next Version":{
+ "Next Version": {
"message": "下一版本"
- }
+ }
}
diff --git a/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/consul.md b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/consul.md
new file mode 100644
index 0000000000..9ac47a71fc
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/consul.md
@@ -0,0 +1,75 @@
+---
+description: Consul
+sidebar_position: 5
+title: Consul 示例
+---
+
+# Consul 方式注册 ShenYu 网关
+
+## ASP.NET Core 项目
+
+对于 ASP.NET Core 项目,我们可以参考这个 [example code](https://github.com/apache/shenyu-client-dotnet/tree/main/examples/AspNetCoreExample)。你需要做以下步骤。
+
+1. 将 ShenYu 加入到 ASP.NET Core 项目依赖中。
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. 在 `Startup.ConfigureServices` 中加入 `ShenyuRegister` service。
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. 在 `appsettings.json` 中进行配置。
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "consul",
+ "ServerList": "localhost:8500",
+ "Props": {
+ "Id": "shenyuAdmin",
+ "Name": "shenyuAdmin",
+ "Tags": "test1,test2",
+ "Port": 8500,
+ "EnableTagOverride": false,
+ "Token": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. 开启允许通过 ip 访问
+
+当运行 ASP.NET Core 项目时,默认只能通过 `localhost` 访问。想要允许 ip 访问,需要设置下 `ASPNETCORE_URLS` 环境变量。
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. 启动 application
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+至此,你已经完成所有的步骤,可以进入 `shenyu-admin` 页面看到这些 API 已经注册到 ShenYu.
diff --git a/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/etcd.md b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/etcd.md
new file mode 100644
index 0000000000..48505ff937
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/etcd.md
@@ -0,0 +1,77 @@
+---
+description: Etcd
+sidebar_position: 4
+title: Etcd 示例
+---
+
+# Etcd 方式注册 ShenYu 网关
+
+## ASP.NET Core 项目
+
+对于 ASP.NET Core 项目,我们可以参考这个 [example code](https://github.com/apache/shenyu-client-dotnet/tree/main/examples/AspNetCoreExample)。你需要做以下步骤。
+
+1. 将 ShenYu 加入到 ASP.NET Core 项目依赖中。
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. 在 `Startup.ConfigureServices` 中加入 `ShenyuRegister` service。
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. 在 `appsettings.json` 中进行配置。
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "ServerList": "http://127.0.0.1:2379",
+ "RegisterType": "etcd",
+ "Props": {
+ // etcd userName,if have not set ectd server userName,this parmas can empty
+ "UserName": "",
+ // etcd password,if have not set ectd server password,this parmas can empty
+ "Password": "",
+ // 3000 ms default
+ "EtcdTimeout": 4000,
+ // 5 ms default
+ "EtcdTTL": 15
+ }
+ },
+ "Client": {
+ "AppName": "dotnetexampleetcd",
+ "ContextPath": "/etcddotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. 开启允许通过 ip 访问
+
+当运行 ASP.NET Core 项目时,默认只能通过 `localhost` 访问。想要允许 ip 访问,需要设置下 `ASPNETCORE_URLS` 环境变量。
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. 启动 application
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+至此,你已经完成所有的步骤,可以进入 `shenyu-admin` 页面看到这些 API 已经注册到 ShenYu.
diff --git a/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/http.md b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/http.md
new file mode 100644
index 0000000000..d4d18e70d1
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/http.md
@@ -0,0 +1,72 @@
+---
+title: "Http 示例"
+sidebar_position: 1
+---
+
+# HTTP 方式注册 ShenYu 网关
+
+## ASP.NET Core 项目
+
+对于 ASP.NET Core 项目,我们可以参考这个 [example code](https://github.com/apache/shenyu-client-dotnet/tree/main/examples/AspNetCoreExample)。你需要做以下步骤。
+
+1. 将 ShenYu 加入到 ASP.NET Core 项目依赖中。
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. 在 `Startup.ConfigureServices` 中加入 `ShenyuRegister` service。
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. 在 `appsettings.json` 中配置 http 信息。
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "http",
+ "ServerList": "http://localhost:9095",
+ "Props": {
+ // your admin user name
+ "UserName": "admin",
+ // your admin password
+ "Password": "123456"
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. 开启允许通过 ip 访问
+
+当运行 ASP.NET Core 项目时,默认只能通过 `localhost` 访问。想要允许 ip 访问,需要设置下 `ASPNETCORE_URLS` 环境变量。
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. 启动 application
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+至此,你已经完成所有的步骤,可以进入 `shenyu-admin` 页面看到这些 API 已经注册到 ShenYu.
diff --git a/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/nacos.md b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/nacos.md
new file mode 100644
index 0000000000..16f3e0640a
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/nacos.md
@@ -0,0 +1,79 @@
+---
+description: Nacos
+sidebar_position: 3
+title: Nacos 示例
+---
+
+# Nacos 方式注册 ShenYu 网关
+
+## ASP.NET Core 项目
+
+对于 ASP.NET Core 项目,我们可以参考这个 [example code](https://github.com/apache/shenyu-client-dotnet/tree/main/examples/AspNetCoreExample)。你需要做以下步骤。
+
+1. 将 ShenYu 加入到 ASP.NET Core 项目依赖中。
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. 在 `Startup.ConfigureServices` 中加入 `ShenyuRegister` service。
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. 在 `appsettings.json` 中进行配置。
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "nacos",
+ "ServerList": "localhost:8848",
+ "Props": {
+ // your nacos user name
+ "UserName": "nacos",
+ // your nacos password
+ "Password": "nacos",
+ // align with the namespace set in admin project
+ "Namespace": "ShenyuRegisterCenter",
+ // when want to aliyun AccessKey ,can ignore
+ "AccessKey": "",
+ // when want to aliyun SecretKey,can ignore
+ "SecretKey": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. 开启允许通过 ip 访问
+
+当运行 ASP.NET Core 项目时,默认只能通过 `localhost` 访问。想要允许 ip 访问,需要设置下 `ASPNETCORE_URLS` 环境变量。
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. 启动 application
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+至此,你已经完成所有的步骤,可以进入 `shenyu-admin` 页面看到这些 API 已经注册到 ShenYu.
diff --git a/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/zookeeper.md b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/zookeeper.md
new file mode 100644
index 0000000000..d383960076
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-shenyuClientDotnet/current/zookeeper.md
@@ -0,0 +1,77 @@
+---
+description: Zookeeper
+sidebar_position: 2
+title: Zookeeper 示例
+---
+
+# Zookeeper 方式注册 ShenYu 网关
+
+## ASP.NET Core 项目
+
+对于 ASP.NET Core 项目,我们可以参考这个 [example code](https://github.com/apache/shenyu-client-dotnet/tree/main/examples/AspNetCoreExample)。你需要做以下步骤。
+
+1. 将 ShenYu 加入到 ASP.NET Core 项目依赖中。
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. 在 `Startup.ConfigureServices` 中加入 `ShenyuRegister` service。
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. 在 `appsettings.json` 中进行配置。
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "zookeeper",
+ "ServerList": "localhost:2181",
+ "Props": {
+ // 3000 ms by default
+ "SessionTimeout": 60000,
+ //3000 ms by default
+ "ConnectionTimeout": 60000,
+ // 1000 ms by default
+ "OperatingTimeout": 1000,
+ // digest
+ "Digest": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. 开启允许通过 ip 访问
+
+当运行 ASP.NET Core 项目时,默认只能通过 `localhost` 访问。想要允许 ip 访问,需要设置下 `ASPNETCORE_URLS` 环境变量。
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. 启动 application
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+至此,你已经完成所有的步骤,可以进入 `shenyu-admin` 页面看到这些 API 已经注册到 ShenYu.
diff --git a/shenyuClientDotnet/consul.md b/shenyuClientDotnet/consul.md
new file mode 100644
index 0000000000..abbd480517
--- /dev/null
+++ b/shenyuClientDotnet/consul.md
@@ -0,0 +1,80 @@
+---
+description: Consul
+sidebar_position: 5
+title: Consul Example
+---
+
+# Consul Registration get start
+
+## ASP.NET Core project
+
+For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
+simple and straightforward.
+
+1. add the Shenyu ASP.NET Core dependency into project.
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. set your `Shenyu` configurations in `appsettings.json`.
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "consul",
+ "ServerList": "localhost:8500",
+ "Props": {
+ "Id": "shenyuAdmin",
+ "Name": "shenyuAdmin",
+ "Tags": "test1,test2",
+ "Port": 8500,
+ "EnableTagOverride": false,
+ "Token": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. enable calling via ip.
+
+When running on your local machine, ASP.NET Core service can only be called from `localhost`. To enable calling by IP,
+you can replace `https://localhost:{port};http://localhost:{port}` with `https://*:{port};http://*:{port}`
+
+Setting by environment variables `ASPNETCORE_URLS`. e.g. `ASPNETCORE_URLS "http://*:5000"`
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. start the application.
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+That's all! After finished above steps, you can start your project in IDE or below commands and you can
+visit `shenyu-admin` portal to see the APIs have been registered in Shenyu.
diff --git a/shenyuClientDotnet/etcd.md b/shenyuClientDotnet/etcd.md
new file mode 100644
index 0000000000..7fca2453c8
--- /dev/null
+++ b/shenyuClientDotnet/etcd.md
@@ -0,0 +1,82 @@
+---
+description: Etcd
+sidebar_position: 4
+title: Etcd Example
+---
+
+# Etcd Registration get start
+
+## ASP.NET Core project
+
+For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
+simple and straightforward.
+
+1. add the Shenyu ASP.NET Core dependency into project.
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. set your `Shenyu` configurations in `appsettings.json`.
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "ServerList": "http://127.0.0.1:2379",
+ "RegisterType": "etcd",
+ "Props": {
+ // etcd userName,if have not set ectd server userName,this parmas can empty
+ "UserName": "",
+ // etcd password,if have not set ectd server password,this parmas can empty
+ "Password": "",
+ // 3000 ms default
+ "EtcdTimeout": 4000,
+ // 5 ms default
+ "EtcdTTL": 15
+ }
+ },
+ "Client": {
+ "AppName": "dotnetexampleetcd",
+ "ContextPath": "/etcddotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. enable calling via ip.
+
+When running on your local machine, ASP.NET Core service can only be called from `localhost`. To enable calling by IP,
+you can replace `https://localhost:{port};http://localhost:{port}` with `https://*:{port};http://*:{port}`
+
+Setting by environment variables `ASPNETCORE_URLS`. e.g. `ASPNETCORE_URLS "http://*:5000"`
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. start the application.
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+That's all! After finished above steps, you can start your project in IDE or below commands and you can
+visit `shenyu-admin` portal to see the APIs have been registered in Shenyu.
diff --git a/shenyuClientDotnet/http.md b/shenyuClientDotnet/http.md
new file mode 100644
index 0000000000..6ba7a99b14
--- /dev/null
+++ b/shenyuClientDotnet/http.md
@@ -0,0 +1,78 @@
+---
+description: http
+sidebar_position: 1
+title: Http Example
+---
+
+# HTTP Registration get start
+
+## ASP.NET Core project
+
+For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
+simple and straightforward.
+
+1. add the Shenyu ASP.NET Core dependency into project.
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. set your `Shenyu` configurations in `appsettings.json`.
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "http",
+ "ServerList": "http://localhost:9095",
+ "Props": {
+ // your admin user name
+ "UserName": "admin",
+ // your admin password
+ "Password": "123456"
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. enable calling via ip.
+
+When running on your local machine, ASP.NET Core service can only be called from `localhost`. To enable calling by IP,
+you can replace `https://localhost:{port};http://localhost:{port}` with `https://*:{port};http://*:{port}`
+
+Setting by environment variables `ASPNETCORE_URLS`. e.g. `ASPNETCORE_URLS "http://*:5000"`
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. start the application.
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+That's all! After finished above steps, you can start your project in IDE or below commands and you can
+visit `shenyu-admin` portal to see the APIs have been registered in Shenyu.
diff --git a/shenyuClientDotnet/nacos.md b/shenyuClientDotnet/nacos.md
new file mode 100644
index 0000000000..fa22324f6b
--- /dev/null
+++ b/shenyuClientDotnet/nacos.md
@@ -0,0 +1,84 @@
+---
+description: Nacos
+sidebar_position: 3
+title: Nacos Example
+---
+
+# Nacos Registration get start
+
+## ASP.NET Core project
+
+For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
+simple and straightforward.
+
+1. add the Shenyu ASP.NET Core dependency into project.
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. set your `Shenyu` configurations in `appsettings.json`.
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "nacos",
+ "ServerList": "localhost:8848",
+ "Props": {
+ // your nacos user name
+ "UserName": "nacos",
+ // your nacos password
+ "Password": "nacos",
+ // align with the namespace set in admin project
+ "Namespace": "ShenyuRegisterCenter",
+ // when want to aliyun AccessKey ,can ignore
+ "AccessKey": "",
+ // when want to aliyun SecretKey,can ignore
+ "SecretKey": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. enable calling via ip.
+
+When running on your local machine, ASP.NET Core service can only be called from `localhost`. To enable calling by IP,
+you can replace `https://localhost:{port};http://localhost:{port}` with `https://*:{port};http://*:{port}`
+
+Setting by environment variables `ASPNETCORE_URLS`. e.g. `ASPNETCORE_URLS "http://*:5000"`
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. start the application.
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+That's all! After finished above steps, you can start your project in IDE or below commands and you can
+visit `shenyu-admin` portal to see the APIs have been registered in Shenyu.
diff --git a/shenyuClientDotnet/zookeeper.md b/shenyuClientDotnet/zookeeper.md
new file mode 100644
index 0000000000..4f18798635
--- /dev/null
+++ b/shenyuClientDotnet/zookeeper.md
@@ -0,0 +1,82 @@
+---
+description: Zookeeper
+sidebar_position: 2
+title: Zookeeper Example
+---
+
+# Zookeeper Registration get start
+
+## ASP.NET Core project
+
+For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
+simple and straightforward.
+
+1. add the Shenyu ASP.NET Core dependency into project.
+
+```shell
+dotnet add package <todo-shenyu-asp.net-core package>
+```
+
+2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
+
+```c#
+public void ConfigureServices(IServiceCollection services)
+{
+ ...
+ services.AddShenyuRegister(this.Configuration);
+ ...
+}
+```
+
+3. set your `Shenyu` configurations in `appsettings.json`.
+
+```json
+{
+ "Shenyu": {
+ "Register": {
+ "RegisterType": "zookeeper",
+ "ServerList": "localhost:2181",
+ "Props": {
+ // 3000 ms by default
+ "SessionTimeout": 60000,
+ //3000 ms by default
+ "ConnectionTimeout": 60000,
+ // 1000 ms by default
+ "OperatingTimeout": 1000,
+ // digest
+ "Digest": ""
+ }
+ },
+ "Client": {
+ "AppName": "dotnet-example",
+ "ContextPath": "/dotnet",
+ "IsFull": false,
+ "ClientType": "http"
+ }
+ }
+}
+```
+
+4. enable calling via ip.
+
+When running on your local machine, ASP.NET Core service can only be called from `localhost`. To enable calling by IP,
+you can replace `https://localhost:{port};http://localhost:{port}` with `https://*:{port};http://*:{port}`
+
+Setting by environment variables `ASPNETCORE_URLS`. e.g. `ASPNETCORE_URLS "http://*:5000"`
+
+```shell
+export ASPNETCORE_URLS=http://+:5000
+```
+
+5. start the application.
+
+```shell
+# build project
+dotnet build --configuration Release
+# start project
+cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
+dotnet AspNetCoreExample.dll
+```
+
+That's all! After finished above steps, you can start your project in IDE or below commands and you can
+visit `shenyu-admin` portal to see the APIs have been registered in Shenyu.
diff --git a/src/data/docsInfo.js b/src/data/docsInfo.js
index 843cbae6e0..0b8c01ca60 100644
--- a/src/data/docsInfo.js
+++ b/src/data/docsInfo.js
@@ -1,34 +1,54 @@
-import React from 'react';
+import React from "react";
import Translate from "@docusaurus/Translate";
export default [
- {
- 'docsTitle': <Translate>Apache ShenYu Docs</Translate>,
- 'projectName': 'Apache ShenYu',
- 'description': <Translate>The document for Apache ShenYu</Translate>,
- 'latestVersion': 'docs/index',
- 'nextVersion': 'docs/next/index',
- 'versionsList': [
- { 'next': 'docs/next/index' },
- { '2.5.0': 'docs/index' },
- { '2.4.3': 'docs/2.4.3/index' },
- { '2.4.2': 'docs/2.4.2/index' },
- { '2.4.1': 'docs/2.4.1/index' },
- { '2.4.0': 'docs/2.4.0/index' },
- { '2.3.0-Legacy': 'docs/2.3.0-Legacy/index' },
- ]
- },
- {
- 'docsTitle': <Translate>ShenYu Nginx Docs</Translate>,
- 'projectName': 'ShenYu Nginx',
- 'description': <Translate>This module provided SDK to watch available ShenYu instance list as upstream nodes by Service Register Center for OpenResty.</Translate>,
- 'latestVersion': 'shenyuNginx/index',
- },
- {
- 'docsTitle': <Translate>Shenyu-client-golang Docs</Translate>,
- 'projectName': 'Shenyu-client-golang',
- 'description': <Translate>Shenyu-client-golang for Go client allows you to access ShenYu Gateway,it supports registory go service to ShenYu Gateway.</Translate>,
- 'latestVersion': 'shenyuClientGolang/http',
- }
- ]
-
\ No newline at end of file
+ {
+ docsTitle: <Translate>Apache ShenYu Docs</Translate>,
+ projectName: "Apache ShenYu",
+ description: <Translate>The document for Apache ShenYu</Translate>,
+ latestVersion: "docs/index",
+ nextVersion: "docs/next/index",
+ versionsList: [
+ { next: "docs/next/index" },
+ { "2.5.0": "docs/index" },
+ { "2.4.3": "docs/2.4.3/index" },
+ { "2.4.2": "docs/2.4.2/index" },
+ { "2.4.1": "docs/2.4.1/index" },
+ { "2.4.0": "docs/2.4.0/index" },
+ { "2.3.0-Legacy": "docs/2.3.0-Legacy/index" },
+ ],
+ },
+ {
+ docsTitle: <Translate>ShenYu Nginx Docs</Translate>,
+ projectName: "ShenYu Nginx",
+ description: (
+ <Translate>
+ This module provided SDK to watch available ShenYu instance list as
+ upstream nodes by Service Register Center for OpenResty.
+ </Translate>
+ ),
+ latestVersion: "shenyuNginx/index",
+ },
+ {
+ docsTitle: <Translate>ShenYu-client-golang Docs</Translate>,
+ projectName: "Shenyu-client-golang",
+ description: (
+ <Translate>
+ Shenyu-client-golang for Go client allows you to access ShenYu
+ Gateway,it supports registory go service to ShenYu Gateway.
+ </Translate>
+ ),
+ latestVersion: "shenyuClientGolang/http",
+ },
+ {
+ docsTitle: <Translate>ShenYu .NET Client Docs</Translate>,
+ projectName: "Shenyu .NET Client",
+ description: (
+ <Translate>
+ ShenYu .NET client allows you to register your Apps to ShenYu Gateway
+ automatically and use ShenYu as gateway easily.
+ </Translate>
+ ),
+ latestVersion: "shenyuClientDotnet/http",
+ },
+];