1 Star 0 Fork 985

wangpf / soul

forked from Apache ShenYu / shenyu 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Light Logo Dark Logo

Scalable, High Performance, Responsive API Gateway Solution for all MicroServices

https://shenyu.apache.org/

EN docs 简体中文文档

github forks github stars github contributors



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)

Run Apache ShenYu Admin

> docker pull apache/shenyu-admin
> docker network create shenyu
> docker run -d -p 9095:9095 --net shenyu apache/shenyu-admin

Run Apache ShenYu Bootstrap

> docker network create shenyu
> docker pull apache/shenyu-bootstrap
> docker run -d -p 9195:9195 --net shenyu apache/shenyu-bootstrap

Set router

{
  "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": "/**"
        }]
    }]
}'
{
  "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 .


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 1.8+

Stargazers over time

Stargazers over time


Contributor and Support


Known Users

In order of registration, More access companies are welcome to register at https://github.com/apache/shenyu/issues/68 (For open source users only) .

All Users : Known Users

# # 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. # header: license: spdx-id: Apache-2.0 copyright-owner: Apache Software Foundation paths-ignore: - '**/target/**' - '**/logs/**' - '**/*.log' - '**/*.tar.gz' - '**/spring.factories' - '**/spring.provides' - '/script/**' - '**/*.json' - '**/*.iml' - '**/.idea/**' - '**/*.classpath' - '**/.project' - '**/.settings/**' - '**/dependency-reduced-pom.xml' - '**/.gitignore' - '**/.gitmodules' - '**/.git/**' - '**/.travis.yml' - '**/.codecov.yml' - '**/.mvn/jvm.config' - '**/.mvn/wrapper/maven-wrapper.properties' - '**/.github/**' - '**/*.md' - '**/*.MD' - '**/*.txt' - '**/docs/**' - '**/.babelrc' - '**/.editorconfig' - '**/.eslintignore' - '**/assets/**' - '**/dist/**' - '**/etc/**' - '**/node/**' - '**/node_modules/**' - '**/test/coverage/**' - '.mvn' - 'shenyu-dist' - 'shenyu-dashboard' - 'DISCLAIMER' - 'licenses' - 'LICENSE' - 'NOTICE' - '**/static/**' comment: on-failure

简介

JAVA语言中高性能,可插拔,响应式API网关 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/reck/soul.git
git@gitee.com:reck/soul.git
reck
soul
soul
master

搜索帮助

14c37bed 8189591 565d56ea 8189591