| Oct |
NOV |
Dec |
|
19 |
|
| 2019 |
2020 |
2021 |
About this capture
The Wayback Machine - http://web.archive.org/web/20201119182140/https://github.com/apache/apisix
Skip to content
/;ref_cta:Sign up;ref_loc:header logged out">
Sign up
●
Features →
●Code review
●Project management
●Integrations
●Actions
●Packages
●Security
●Team management
●Hosting
●Mobile
●Customer stories →
●Security →
●
●
●
●Explore GitHub →
Learn & contribute
●Topics
●Collections
●Trending
●Learning Lab
●Open source guides
Connect with others
●Events
●Community forum
●GitHub Education
●GitHub Stars program
●
●
Plans →
●Compare plans
●Contact Sales
●Nonprofit →
●Education →
In this repository
All GitHub
↵
Jump to
↵
-
No suggested jump to results
{{ message }}
●
Watch
201
●
Star
3.7k
●
Fork
736
The Cloud-Native API Gateway
apisix.apache.org/
Apache-2.0 License
3.7k
stars
736
forks
Star
Watch
●
Code
●
Issues
260
●
Pull requests
34
●
Actions
●
Projects
0
●
Wiki
●
Security
●
Insights
More
●
Code
●
Issues
●
Pull requests
●
Actions
●
Projects
●
Wiki
●
Security
●
Insights
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Sign up for free
16
branches
19
tags
Go to file
Code
Clone
Use Git or checkout with SVN using the web URL.
Work fast with our official CLI.
Learn more.
●
Open with GitHub Desktop
●
Download ZIP
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio
If nothing happens, download the GitHub extension for Visual Studio and try again.
Latest commit
pahud
chore(doc): add aws doc (#2567)
a0c7d62
Nov 19, 2020
chore(doc): add aws doc (#2567)
a0c7d62
Git stats
●
1,459
commits
Files
Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
.github
feat(CI): create markdown-link-checker.yml (#2684)
Nov 10, 2020
.travis
test: improve bin/apisix test cases. (#2761)
Nov 17, 2020
apisix
feat: Improve zipkin span reporter performance (#2727)
Nov 19, 2020
benchmark
Is this PR backward compatible?
Disable two plugins by default(proxy-cache, proxy-mirror), if the user wants to enable them, need to modify the conf/config.yaml by manual." class="link-gray" href="/web/20201119182140/https://github.com/apache/apisix/commit/d32b5cf361fff72eeec5b1f7ddb23a53c4142e51">perf: no longer generate unnecessary nginx conf for better performanc…
Aug 4, 2020
bin
feat: support ENV variable in configuration (#2743)
Nov 14, 2020
conf
feat: support plugin for "aliyun" log service (#2177)
Nov 18, 2020
doc
chore(doc): add aws doc (#2567)
Nov 19, 2020
kubernetes
fix: change the config file when deploying apisix in k8s #2182 (#2185)
Sep 14, 2020
logos
chore: upload apisix logo image (#2371)
Oct 10, 2020
rockspec
fix: upgrade lua-resty-etcd to 1.4.2 (#2701)
Nov 12, 2020
t
feat: Improve zipkin span reporter performance (#2727)
Nov 19, 2020
utils
ci: refactor runners (#2722)
Nov 15, 2020
.asf.yaml
change(ASF): add notifications to mailing list. (#1635)
Jun 1, 2020
.gitattributes
feature: fixed language of github linguist. (#351)
Aug 1, 2019
.gitignore
fix: use same config-default.yaml for different environments (#2663)
Nov 10, 2020
.luacheckrc
improve(CLI): move ngx_tpl to apisix/cli/ngx_tpl.lua (#2581)
Oct 31, 2020
CHANGELOG.md
release: release 2.0 version. (#2283)
Oct 27, 2020
CHANGELOG_CN.md
Update CHANGELOG_CN.md (#2560)
Oct 30, 2020
CODE_OF_CONDUCT.md
fix(doc): broken links (#2682)
Nov 10, 2020
CODE_STYLE.md
chore: update CODE_STYLE to catch up with the reality (#2570)
Oct 30, 2020
CODE_STYLE_CN.md
doc: added CODE_STYLE.md and CODE_STYLE_CN.md for APISIX (#1874)
Jul 22, 2020
CONTRIBUTING.md
" class="link-gray" href="/web/20201119182140/https://github.com/apache/apisix/commit/ef6bc442ae9bbc4a8d1a616a2b3737ceacaef9ce">chore: fix broken link (#2404" class="link-gray" href="/web/20201119182140/https://github.com/apache/apisix/commit/ef6bc442ae9bbc4a8d1a616a2b3737ceacaef9ce">)
Oct 14, 2020
FAQ.md
fix: plugin hot reload should work on node (#2430)
Nov 3, 2020
FAQ_CN.md
doc: remove meanless content (#2669)
Nov 9, 2020
LICENSE
license: fixed license issue for ewma.lua. (#2136)
Aug 31, 2020
Makefile
feat: support plugin for "aliyun" log service (#2177)
Nov 18, 2020
NOTICE
release: released 1.4.1 version (#1872)
Jul 20, 2020
README.md
doc: add videos of ApacheCon. (#2534)
Oct 28, 2020
README_CN.md
doc: add videos of ApacheCon. (#2534)
Oct 28, 2020
README.md
Apache APISIX
English •
中文
Website •
Docs •
Dashboard •
Twitter
What's Apache APISIX?
Apache APISIX is a dynamic, real-time, high-performance API gateway, based on the Nginx library and etcd.
APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, and more.
You can use Apache APISIX to handle traditional north-south traffic,
as well as east-west traffic between services.
It can also be used as a k8s ingress controller.
The technical architecture of Apache APISIX:
Contents
●Features
●Documentation
●Get Started
●Dashboard
●Benchmark
●Apache APISIX vs Kong
●Open Governance
●Community
●Videos And Articles
●User Stories
●Who Uses APISIX?
●Landscape
●Logos
●Contributing
●Acknowledgments
●License
Features
You can use Apache APISIX as a traffic entrance to process all business data, including dynamic routing, dynamic upstream, dynamic certificates,
A/B testing, canary release, blue-green deployment, limit rate, defense against malicious attacks, metrics, monitoring alarms, service observability, service governance, etc.
All platforms
●Cloud-Native: Platform agnostic, No vendor lock-in, APISIX can run from bare-metal to Kubernetes.
●Run Environment: Both OpenResty and Tengine are supported.
●Supports ARM64: Don't worry about the lock-in of the infra technology.
Multi protocols
●TCP/UDP Proxy: Dynamic TCP/UDP proxy.
●Dynamic MQTT Proxy: Supports to load balance MQTT by client_id, both support MQTT 3.1.*, 5.0.
●gRPC proxy: Proxying gRPC traffic.
●gRPC transcoding: Supports protocol transcoding so that clients can access your gRPC API by using HTTP/JSON.
●Proxy Websocket
●Proxy Protocol
●Proxy Dubbo: Dubbo Proxy based on Tengine.
●HTTP(S) Forward Proxy
●SSL: Dynamically load an SSL certificate.
Full dynamic
●Hot Updates And Hot Plugins: Continuously updates its configurations and plugins without restarts!
●Proxy Rewrite: Support rewrite the host, uri, schema, enable_websocket, headers of the request before send to upstream.
●Response Rewrite: Set customized response status code, body and header to the client.
●Serverless: Invoke functions in each phase in APISIX.
●Dynamic Load Balancing: Round-robin load balancing with weight.
●Hash-based Load Balancing: Load balance with consistent hashing sessions.
●Health Checks: Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
●Circuit-Breaker: Intelligent tracking of unhealthy upstream services.
●Proxy Mirror: Provides the ability to mirror client requests.
Fine-grained routing
●Supports full path matching and prefix matching
●Support all Nginx built-in variables as conditions for routing, so you can use cookie, args, etc. as routing conditions to implement canary release, A/B testing, etc.
●Support various operators as judgment conditions for routing, for example {"arg_age", ">", 24}
●Support custom route matching function
●IPv6: Use IPv6 to match route.
●Support TTL
●Support priority
●Support Batch Http Requests
Security
●Authentications: key-auth, JWT, basic-auth, wolf-rbac
●IP Whitelist/Blacklist
●Referer Whitelist/Blacklist
●IdP: Support external authentication services, such as Auth0, okta, etc., users can use this to connect to OAuth 2.0 and other authentication methods.
●Limit-req
●Limit-count
●Limit-concurrency
●Anti-ReDoS(Regular expression Denial of Service): Built-in policies to Anti ReDoS without configuration.
●CORS Enable CORS(Cross-origin resource sharing) for your API.
●URI Blocker: Block client request by URI.
●Request Validator
OPS friendly
●OpenTracing: support Apache Skywalking and Zipkin
●works with external service discovery‥In addition to the built-in etcd, it also supports Consul and Nacos DNS discovery mode, and Eureka
●Monitoring And Metrics: Prometheus
●Clustering: APISIX nodes are stateless, creates clustering of the configuration center, please refer to etcd Clustering Guide.
●High availability: support to configure multiple etcd addresses in the same cluster.
●Dashboard: Built-in dashboard to control APISIX.
●Version Control: Supports rollbacks of operations.
●CLI: start\stop\reload APISIX through the command line.
●Stand-alone mode: Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
●Global Rule: Allows to run any plugin for all request, eg: limit rate, IP filter etc.
●High performance: The single-core QPS reaches 18k with an average delay of less than 0.2 milliseconds.
●Fault Injection
●REST Admin API: Using the REST Admin API to control Apache APISIX, which only allows 127.0.0.1 access by default, you can modify the allow_admin field in conf/config.yaml to specify a list of IPs that are allowed to call the Admin API. Also note that the Admin API uses key auth to verify the identity of the caller. The admin_key field in conf/config.yaml needs to be modified before deployment to ensure security.
●External Loggers: Export access logs to external log management tools. (HTTP Logger, TCP Logger, Kafka Logger, UDP Logger)
Highly scalable
●Custom plugins: Allows hooking of common phases, such as rewrite, access, header filer, body filter and log, also allows to hook the balancer stage.
●Custom load balancing algorithms: You can use custom load balancing algorithms during the balancer phase.
●Custom routing: Support users to implement routing algorithms themselves.
Documentation
Document Indexing for Apache APISIX
Get Started
Configure and Installation
APISIX Installed and tested in the following systems:
CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, ARM64 Ubuntu 18.04
There are several ways to install the Apache Release version of APISIX:
Source code compilation (applicable to all systems)
●Installation runtime dependencies: OpenResty and etcd, and compilation dependencies: luarocks. Refer to install dependencies documentation
●Download the latest source code release package:
$ mkdir apisix-2.0
$ cd apisix-2.0
$ wget https://downloads.apache.org/apisix/2.0/apache-apisix-2.0-src.tgz
$ tar zxvf apache-apisix-2.0-src.tgz
●Install the dependencies‥
$ make deps
●check version of APISIX:
$ ./bin/apisix version
●start APISIX:
$ ./bin/apisix start
Docker image ︵applicable to all systems︶
By default, the latest Apache release package will be pulled:
$ docker pull apache/apisix
The Docker image does not include etcd, you can refer to docker compose example to start a test cluster.
RPM package︵only for CentOS 7︶
●Installation runtime dependencies: OpenResty and etcd, refer to install dependencies documentation
●install APISIX‥
$ sudo yum install -y https://github.com/apache/apisix/releases/download/2.0/apisix-2.0-0.el7.noarch.rpm
●check version of APISIX:
$ apisix version
●start APISIX:
$ apisix start
Note: Apache APISIX would not support the v2 protocol of etcd anymore since APISIX v2.0, and the minimum etcd version supported is v3.4.0. Please update etcd when needed. If you need to migrate your data from etcd v2 to v3, please follow etcd migration guide.
For Developer
For developers, you can use the latest master branch to experience more features
●build from source code
$ git clone git@github.com:apache/apisix.git
$ cd apisix
$ make deps
●Docker image
$ git clone https://github.com/apache/apisix-docker.git
$ cd apisix-docker
$ sudo docker build -f alpine-dev/Dockerfile .
Getting start
The getting started guide is a great way to learn the basics of APISIX, just follow the steps in Getting Started.
Further, you can follow the documentation to try more plugins.
Admin API
Apache APISIX provides REST Admin API to dynamic control the Apache APISIX cluster.
Plugin development
You can refer to plugin development guide, and sample plugin echo documentation and code implementation.
Please note that Apache APISIX plugins' added, updated, deleted, etc. are hot loaded, without restarting the service.
For more documents, please refer to Apache APISIX Document Index
Dashboard
APISIX has built-in support for Dashboard, which could be directly deployed by docker compose.
The dashboard only allows 127.0.0.1 by default, and you can modify allow_admininconf/config.yaml by yourself, to list the list of IPs allowed to access.
Benchmark
Using AWS's 8 core server, APISIX's QPS reach to 140,000 with a latency of only 0.2 ms.
benckmark script, test method and process has been open source, welcome to try and contribute.
Apache APISIX vs Kong
Both of them have been covered core features of API gateway
| Features |
Apache APISIX |
KONG |
| Dynamic upstream |
Yes |
Yes |
| Dynamic router |
Yes |
Yes |
| Health check |
Yes |
Yes |
| Dynamic SSL |
Yes |
Yes |
| L4 and L7 proxy |
Yes |
Yes |
| Opentracing |
Yes |
Yes |
| Custom plugin |
Yes |
Yes |
| REST API |
Yes |
Yes |
| CLI |
Yes |
Yes |
The advantages of Apache APISIX
| Features |
Apache APISIX |
Kong |
| Belongs to |
Apache Software Foundation |
Kong Inc. |
| Tech Architecture |
Nginx + etcd |
Nginx + postgres |
| Communication channels |
Mail list, Wechat group, QQ group, Github, meetup |
Github, freenode, forum |
| Single-core CPU, QPS(enable limit-count and prometheus plugins) |
18000 |
1700 |
| Latency |
0.2 ms |
2 ms |
| Dubbo |
Yes |
No |
| Configuration rollback |
Yes |
No |
| Route with TTL |
Yes |
No |
| Plug-in hot loading |
Yes |
No |
| Custom LB and route |
Yes |
No |
| REST API <--> gRPC transcoding |
Yes |
No |
| Tengine |
Yes |
No |
| MQTT |
Yes |
No |
| Configuration effective time |
Event driven, < 1ms |
polling, 5 seconds |
| Dashboard |
Yes |
No |
| IdP |
Yes |
No |
| Configuration Center HA |
Yes |
No |
| Speed limit for a specified time window |
Yes |
No |
| Support any Nginx variable as routing condition |
Yes |
No |
Benchmark comparison test details data
Open Governance
GitHub milestones lay out the path to Apache APISIX's future improvements.
Community
●Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe the mailing list.
●QQ Group - 578997126, 552030619
●Slack Workspace - join #apisix on our Slack to meet the team and ask questions
- follow and interact with us using hashtag #ApacheAPISIX
●bilibili video
Contributor Over Time
Videos And Articles
●Apache APISIX: How to implement plugin orchestration in API Gateway
●Improve Apache APISIX observability with Apache Skywalking
●APISIX technology selection, testing and continuous integration
●Analysis of Excellent Performance of Apache APISIX Microservices Gateway
User Stories
●European Factory Platform: API Security Gateway – Using APISIX in the eFactory Platform
●ke.com: How to Build a Gateway Based on Apache APISIX(Chinese)
●360: Apache APISIX Practice in OPS Platform(Chinese)
●HelloTalk: Exploring Globalization Based on OpenResty and Apache APISIX(Chinese)
●Tencent Cloud: Why choose Apache APISIX to implement the k8s ingress controller?(Chinese)
●aispeech: Why we create a new k8s ingress controller?(Chinese)
Who Uses APISIX?
A wide variety of companies and organizations use APISIX for research, production and commercial product, including:
Users are encouraged to add themselves to the Powered By page.
Landscape
APISIX enriches the
CNCF API Gateway Landscape.
Logos
●Apache APISIX logo(PNG)
●Apache APISIX logo source
Contributing
We welcome all kinds of contributions from the open-source community, individuals and partners.
●Contributing Guide
Acknowledgments
Inspired by Kong and Orange.
License
Apache 2.0 License
About
The Cloud-Native API Gateway
apisix.apache.org/
Topics
apigateway
cloud-native
nginx
api-management
luajit
lua
api-gateway
microservices
apisix
api
loadbalancing
reverse-proxy
serverless
iot
devops
kubernetes
docker
Resources
Readme
License
Apache-2.0 License
2.0
Latest
Oct 28, 2020
+ 18 releases
No packages published
+ 116 contributors
Languages
●
Lua
90.1%
●
Shell
8.9%
●
Makefile
1.0%
●© 2020 GitHub, Inc.
●Terms
●Privacy
●
●Security
●Status
●Help
●Contact GitHub
●Pricing
●API
●Training
●Blog
●About
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
We use optional third-party analytics cookies to understand how you use GitHub.com so we can build better products.
Learn more.
We use optional third-party analytics cookies to understand how you use GitHub.com so we can build better products.
You can always update your selection by clicking Cookie Preferences at the bottom of the page.
For more information, see our Privacy Statement.
Essential cookies
We use essential cookies to perform essential website functions, e.g. they're used to log you in.
Learn more
Always active
Analytics cookies
We use analytics cookies to understand how you use our websites so we can make them better, e.g. they're used to gather information about the pages you visit and how many clicks you need to accomplish a task.
Learn more
Users are encouraged to add themselves to the Powered By page.