This is an automated email from the ASF dual-hosted git repository. hefengen pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/shenyu-plugin-store.git
commit 9f3fdf3faa9e8a1440d59acca16340dc2fce93cd Author: moremind <[email protected]> AuthorDate: Mon Mar 30 20:49:53 2026 +0800 init --- .gitignore | 52 ++++++++++++++ README.md | 225 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ asf.yaml | 41 +++++++++++ 3 files changed, 318 insertions(+) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ed771e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,52 @@ +# maven ignore +target/ +*.class +*.jar +*.war +*.zip +*.tar +*.tar.gz +.flattened-pom.xml +dependency-reduced-pom.xml + +# maven plugin ignore +release.properties +cobertura.ser +*.gpg + +# eclipse ignore +.settings/ +.project +.classpath + +# idea ignore +.idea/ +!/.idea/icon.svg +!/.idea/vcs.xml +*.ipr +*.iml +*.iws + +# temp ignore +logs/ +*.log +*.doc +*.cache +*.diff +*.patch +*.tmp + +# system ignore +.DS_Store +Thumbs.db + +# agent build ignore +/agent/ + +# rust ignore +*.lock + +.factorypath + +# Private individual user cursor rules +.cursor/rules/_*.mdc diff --git a/README.md b/README.md new file mode 100644 index 0000000..8cdbd00 --- /dev/null +++ b/README.md @@ -0,0 +1,225 @@ + + + +<p align="center"> + <strong>Scalable, High Performance, Responsive API Gateway Solution for all MicroServices</strong> +</p> +<p align="center"> + <a href="https://shenyu.apache.org/";>https://shenyu.apache.org/</a> +</p> + +<p align="center"> + <a href="https://shenyu.apache.org/docs/index"; > + <img src="https://img.shields.io/badge/document-English-blue.svg"; alt="EN docs" /> + </a> + <a href="https://shenyu.apache.org/zh/docs/index";> + <img src="https://img.shields.io/badge/文档-简体中文-blue.svg"; alt="简体中文文档" /> + </a> +</p> + +<p align="center"> + <a target="_blank" href="https://search.maven.org/search?q=g:org.apache.shenyu%20AND%20a:shenyu";> + <img src="https://img.shields.io/maven-central/v/org.apache.shenyu/shenyu.svg?label=maven%20central"; /> + </a> + <a target="_blank" href="https://github.com/apache/shenyu/blob/master/LICENSE";> + <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license"; /> + </a> + <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html";> + <img src="https://img.shields.io/badge/JDK-17+-green.svg"; /> + </a> + <a target="_blank" href="https://github.com/apache/shenyu/actions";> + <img src="https://github.com/apache/shenyu/workflows/ci/badge.svg"; /> + </a> + <a target="_blank" href='https://github.com/apache/shenyu'> + <img src="https://img.shields.io/github/forks/apache/shenyu.svg"; alt="github forks"/> + </a> + <a target="_blank" href='https://github.com/apache/shenyu'> + <img src="https://img.shields.io/github/stars/apache/shenyu.svg"; alt="github stars"/> + </a> + <a target="_blank" href='https://github.com/apache/shenyu'> + <img src="https://img.shields.io/github/contributors/apache/shenyu.svg"; alt="github contributors"/> + </a> + <a target="_blank" href="https://codecov.io/gh/apache/shenyu";> + <img src="https://codecov.io/gh/apache/shenyu/branch/master/graph/badge.svg"; /> + </a> + <a target="_blank" href="https://hub.docker.com/r/apache/shenyu-bootstrap/tags";> + <image src="https://img.shields.io/docker/pulls/apache/shenyu-bootstrap"; alt="Docker Pulls"/> + </a> + <a target="_blank" href="https://gitpod.io/#https://github.com/apache/shenyu";> + <image src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod&color=green"/> + </a> + <a target="_blank" href="https://deepwiki.com/apache/shenyu";> + <img src="https://deepwiki.com/badge.svg"; alt="Ask DeepWiki"> + </a> +</p> +<br/> + +--- + +# Architecture + +  + +---- + +# Why named Apache ShenYu + +ShenYu (神禹) is the honorific name of Chinese ancient monarch Xia Yu (also known in later times as Da Yu), +who left behind the touching story of the three times he crossed the Yellow River for the benefit of the people and successfully managed the flooding of the river. +He is known as one of the three greatest kings of ancient China, along with Yao and Shun. + + * Firstly, the name ShenYu is to promote the traditional virtues of our Chinese civilisation. + + * Secondly, the most important thing about the gateway is the governance of the traffic. + + * Finally, the community will do things in a fair, just, open and meritocratic way, paying tribute to ShenYu while also conforming to the Apache Way. + +--- + +# Features + +* Proxy: Support for Apache® Dubbo™, Spring Cloud, gRPC, Motan, SOFA, TARS, WebSocket, MQTT +* Security: Sign, OAuth 2.0, JSON Web Tokens, WAF plugin +* API governance: Request, response, parameter mapping, Hystrix, RateLimiter plugin +* Observability: Tracing, metrics, logging plugin +* Dashboard: Dynamic traffic control, visual backend for user menu permissions +* Extensions: Plugin hot-swapping, dynamic loading +* Cluster: NGINX, Docker, Kubernetes +* Language: provides .NET, Python, Go, Java client for API register + +--- + +# Quick Start (docker) + +### Create network for Shenyu + +``` +> docker network create shenyu +``` + +### Run Apache ShenYu Admin + +``` +> docker pull apache/shenyu-admin +> docker run -d --name shenyu-admin-quickstart -p 9095:9095 --net shenyu apache/shenyu-admin +``` + +### Run Apache ShenYu Bootstrap + +``` +> docker pull apache/shenyu-bootstrap +> docker run -d --name shenyu-quickstart -p 9195:9195 -e "shenyu.local.enabled=true" -e SHENYU_SYNC_WEBSOCKET_URLS=ws://shenyu-admin-quickstart:9095/websocket --net shenyu apache/shenyu-bootstrap +``` + +### Set router + +* Real request ：http://127.0.0.1:8080/helloworld, + +```json +{ + "name" : "Shenyu", + "data" : "hello world" +} +``` + +* Set routing rules (Standalone) + +Add `localKey: 123456` to Headers. If you need to customize the localKey, you can use the sha512 tool to generate the key based on plaintext and update the `shenyu.local.sha512Key` property. + +``` +curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndRules' \ +--header 'Content-Type: application/json' \ +--header 'localKey: 123456' \ +--data-raw '{ + "pluginName": "divide", + "selectorHandler": "[{\"upstreamUrl\":\"127.0.0.1:8080\"}]", + "conditionDataList": [{ + "paramType": "uri", + "operator": "match", + "paramValue": "/**" + }], + "ruleDataList": [{ + "ruleHandler": "{\"loadBalance\":\"random\"}", + "conditionDataList": [{ + "paramType": "uri", + "operator": "match", + "paramValue": "/**" + }] + }] +}' +``` +> If the backend service handling the request is running on your host machine, please set `upstreamUrl` to `host.docker.internal:8080` or specify IP address if reachable from the container in the above command. +> +> Add `--network host` to docker run command instead of `--net shenyu` also works correctly. +* Proxy request ：http://localhost:9195/helloworld + +```json +{ + "name" : "Shenyu", + "data" : "hello world" +} +``` +--- + +# Plugin + + Whenever a request comes in, Apache ShenYu will execute it by all enabled plugins through the chain of responsibility. + + As the heart of Apache ShenYu, plugins are extensible and hot-pluggable. + + Different plugins do different things. + + Of course, users can also customize plugins to meet their own needs. + + If you want to customize, see [custom-plugin](https://shenyu.apache.org/docs/developer/custom-plugin/) . + +--- + +# Selector & Rule + + According to your HTTP request headers, selectors and rules are used to route your requests. + + Selector is your first route, It is coarser grained, for example, at the module level. + + Rule is your second route and what do you think your request should do. For example a method level in a module. + + The selector and the rule match only once, and the match is returned. So the coarsest granularity should be sorted last. + +--- + +# Data Caching & Data Sync + + Since all data have been cached using ConcurrentHashMap in the JVM, it's very fast. + + Apache ShenYu dynamically updates the cache by listening to the ZooKeeper node (or WebSocket push, HTTP long polling) when the user changes configuration information in the background management. + +  + +  + +--- + +# Prerequisite + + * JDK 17+ + +--- + +# Stargazers over time + +[](https://starchart.cc/apache/shenyu.svg) + +--- + +# Contributor and Support + +* [How to Contribute](https://shenyu.apache.org/community/contributor-guide) +* [Mailing Lists](mailto:[email protected]) + +--- + +# Known Users + +In order of registration, More access companies are welcome to register at [https://github.com/apache/shenyu/issues/68](https://github.com/apache/shenyu/issues/68) (For open source users only) . + +All Users : [Known Users](https://shenyu.apache.org/community/user-registration) diff --git a/asf.yaml b/asf.yaml new file mode 100644 index 0000000..1936650 --- /dev/null +++ b/asf.yaml @@ -0,0 +1,41 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +github: + description: Apache ShenYu Plugin Store. + homepage: https://shenyu.apache.org/ + labels: + - shenyu + features: + wiki: true + issues: true + projects: true + enabled_merge_buttons: + squash: true + merge: false + rebase: false + protected_branches: + main: + required_status_checks: + strict: true + required_pull_request_reviews: + dismiss_stale_reviews: true + required_approving_review_count: 1 +notifications: + commits: [email protected] + issues: [email protected] + pullrequests: [email protected]
![https://img.shields.io/badge/document-English-blue.svg"](https://img.shields.io/badge/document-English-blue.svg"){kind=link}
![https://img.shields.io/badge/文档-简体中文-blue.svg"](https://img.shields.io/badge/文档-简体中文-blue.svg"){kind=link}
![https://img.shields.io/maven-central/v/org.apache.shenyu/shenyu.svg?label=maven%20central"](https://img.shields.io/maven-central/v/org.apache.shenyu/shenyu.svg?label=maven%20central"){kind=link}
![https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license"](https://img.shields.io/badge/License-Apache%202.0-blue.svg?label=license"){kind=link}
![https://img.shields.io/badge/JDK-17+-green.svg"](https://img.shields.io/badge/JDK-17+-green.svg"){kind=link}
![https://github.com/apache/shenyu/workflows/ci/badge.svg"](https://github.com/apache/shenyu/workflows/ci/badge.svg"){kind=link}
![https://img.shields.io/github/forks/apache/shenyu.svg"](https://img.shields.io/github/forks/apache/shenyu.svg"){kind=link}
![https://img.shields.io/github/stars/apache/shenyu.svg"](https://img.shields.io/github/stars/apache/shenyu.svg"){kind=link}
![https://img.shields.io/github/contributors/apache/shenyu.svg"](https://img.shields.io/github/contributors/apache/shenyu.svg"){kind=link}
![https://codecov.io/gh/apache/shenyu/branch/master/graph/badge.svg"](https://codecov.io/gh/apache/shenyu/branch/master/graph/badge.svg"){kind=link}
![https://deepwiki.com/badge.svg"](https://deepwiki.com/badge.svg"){kind=link}
