apisix/README.md

中文

APISIX

• QQ group: 552030619
• 
• 

What's APISIX?

APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.

APISIX is based on OpenResty and etcd. Compared with traditional API gateways, APISIX has dynamic routing and plug-in hot loading, which is especially suitable for API management under micro-service system.

Why APISIX?

If you are building a website, mobile device or IoT (Internet of Things) application, you may need to use an API gateway to handle interface traffic.

APISIX is a cloud-based microservices API gateway that handles traditional north-south traffic and handles east-west traffic between services.

APISIX provides dynamic load balancing, authentication, rate limiting, and other plugins through plugin mechanisms, and supports plugins you develop yourself.

For more detailed information, see the White Paper.

Features

• Cloud-Native: Platform agnostic, No vendor lock-in, APISIX can run from bare-metal to Kubernetes.
• Hot Updates And Hot Plugins: Continuously updates its configurations and plugins without restarts!
• Dynamic Load Balancing: Round-robin load balancing with weight.
• Hash-based Load Balancing: Load balance with consistent hashing sessions.
• SSL: Dynamically load an SSL certificate.
• HTTP(S) Forward Proxy
• 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.
• Authentications: key-auth, JWT
• Limit-req
• Limit-count
• Limit-concurrency
• OpenTracing: support Apache Skywalking and Zipkin
• Monitoring And Metrics: Prometheus
• gRPC transcoding：Supports protocol transcoding so that clients can access your gRPC API by using HTTP/JSON.
• Serverless: Invoke functions in each phase in APISIX.
• Custom plugins: Allows hooking of common phases, such as rewrite, access, header filer, body filter and log, also allows to hook the balancer stage.
• Dashboard: Built-in dashboard to control APISIX.
• Version Control: Supports rollbacks of operations.
• CLI: start\stop\reload APISIX through the command line.
• REST API
• Proxy Websocket
• IPv6: Use IPv6 to match route.
• Clustering: APISIX nodes are stateless, creates clustering of the configuration center, please refer to etcd Clustering Guide.
• Scalability: plug-in mechanism is easy to extend.
• High performance: The single-core QPS reaches 24k with an average delay of less than 0.6 milliseconds.
• Anti-ReDoS(Regular expression Denial of Service)
• IP Whitelist/Blacklist
• IdP: Support external authentication services, such as Auth0, okta, etc., users can use this to connect to Oauth2.0 and other authentication methods.
• 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.
• 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.
• ACL: TODO.
• Bot detection: TODO.

Online Demo Dashboard

We provide an online dashboard demo version， make it easier for you to understand APISIX.

Install

APISIX Installed and tested in the following systems, and the version of OpenResty MUST >= 1.15.8.1:

OS
CentOS 7
Ubuntu 16.04
Ubuntu 18.04
Debian 9
Debian 10
Mac OSX

You now have four ways to install APISIX:

• if you are using CentOS 7, it is recommended to use RPM;
• if using MacOS, only support git clone and install by manual, please take a look at dev manual;
• other systems please use Luarocks;
• You can also install from Docker image.

NOTE: APISIX currently only supports the v2 protocol storage to etcd, but the latest version of etcd (starting with 3.4) has turned off the v2 protocol by default. You need to add --enable-v2=true to the startup parameter to enable the v2 protocol. The development of the v3 protocol supporting etcd has begun and will soon be available.

Install from RPM for CentOS 7

sudo yum install yum-utils
sudo yum-config-manager --add-repo https://openresty.org/package/centos/openresty.repo
sudo yum install -y openresty etcd
sudo service etcd start

sudo yum install -y https://github.com/iresty/apisix/releases/download/v0.7/apisix-0.7-0.el7.noarch.rpm

You can try APISIX with the Quickstart now.

Install from Luarocks (not support MacOS)

Dependencies

APISIX is based on OpenResty, the configures data storage and distribution via etcd.

We recommend that you use luarocks to install APISIX, and for different operating systems have different dependencies, see more: Install Dependencies

Install APISIX

luarocks install --lua-dir=/usr/local/openresty/luajit apisix

If you got some error like unknow flag --lua-dir, this is because luarocks version is too low. We need to remove option lua-dir and run again: luarocks install apisix.

If all goes well, you will see the message like this:

apisix is now built and installed in /usr (license: Apache License 2.0)

Congratulations, you have already installed APISIX successfully.

Development Manual of APISIX

If you are a developer, you can view the dev manual for more details.

Quickstart

1. start server:

sudo apisix start

note: If you are in a development environment, start server by command make run.

2. try limit count plugin

Limit count plugin is a good start to try APISIX, you can follow the documentation of limit count.

Then you can try more plugins.

Dashboard

APISIX has the built-in dashboard，open http://127.0.0.1:9080/apisix/dashboard/ with a browser and try it.

Do not need to fill the user name and password, log in directly.

Dashboard allow any remote IP by default, and you can modify allow_admin in conf/config.yaml by yourself, to list the list of IPs allowed to access.

Benchmark

Using Google Cloud's 4 core server, APISIX's QPS reach to 60,000 with a latency of only 500 microseconds.

You can view the benchmark documentation for more detailed information.

Architecture Design

English Development Documentation: TODO

中文开发文档

Videos and slides

• APISIX technology selection, testing and continuous integration(Chinese)

• APISIX high performance practice(Chinese)

Who Uses APISIX?

A wide variety of companies and organizations use APISIX for research, production and commercial product. Here is the User Wall of APISIX.

Users are encouraged to add themselves to the Powered By page.

Landscape

APISIX enriches the CNCF API Gateway Landscape:

FAQ

There are often some questions asked by developers in the community. We have arranged them in the FAQ.

If your concerns are not among them, please submit issue to communicate with us.

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Reference document

See more document, please take look at Reference document.

Acknowledgments

inspired by Kong and Orange.