| commit | 19678ba326677039c19ef256f41453b40cb61f74 | [log] [tgz] |
|---|---|---|
| author | JinChao Shuai <shuaijinchao@gmail.com> | Mon Nov 11 16:19:59 2019 +0800 |
| committer | WenMing <moonbingbing@gmail.com> | Mon Nov 11 16:19:59 2019 +0800 |
| tree | afcc07cee58cced9408ea27c9ac3166fa4bada64 | |
| parent | 5e85e93eac1e255a4c37476237ca439a98a421f3 [diff] |
change: update v0.9.0-rc1 changelog. (#832)
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 Nginx 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.
Installation | Documentation | Development ENV | FAQ
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, other plugins through plugin mechanisms, and supports plugins you develop yourself.
For more detailed information, see the White Paper.
host, uri, schema, enable_websocket, headers information upstream of the request.rewrite, access, header filer, body filter and log, also allows to hook the balancer stage.client_id, both support MQTT 3.1.*, 5.0.We provide an online dashboard demo version， make it easier for you to understand APISIX.
APISIX Installed and tested in the following systems(OpenResty MUST >= 1.15.8.1, or Tengine >= 2.3.2):
There are four ways to install APISIX:
The main steps to install APISIX:
Runtime dependency: OpenResty or Tengine.
Configuration center: Reference etcd.
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 APISIX service.
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/apache/incubator-apisix/releases/download/v0.8/apisix-0.8-0.el7.noarch.rpm
You can try APISIX with the Quickstart now.
APISIX is based on OpenResty or Tengine, 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
APISIX is installed by running the following commands in your terminal.
install the master branch via curl
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/incubator-apisix/master/utils/install-apisix.sh)"
install the specified version via Luarock:
# install apisix with version v0.8 sudo luarocks install --lua-dir=/path/openresty/luajit apisix 0.8 # old luarocks may not support `lua-dir`, we can remove option `lua-dir` sudo luarocks install apisix 0.8
Installation complete
If all goes well, you will see the message like this:
apisix 0.7-0 is now built and installed in /usr/local/apisix/deps (license: Apache License 2.0)
+ sudo rm -f /usr/local/bin/apisix
+ sudo ln -s /usr/local/apisix/deps/bin/apisix /usr/local/bin/apisix
Congratulations, you have already installed APISIX successfully.
If you are a developer, you can view the dev manual for more details.
sudo apisix start
note: If you are in a development environment, start server by command make run.
Limit count plugin is a good start to try APISIX, you can follow the documentation of limit count.
Then you can try more plugins.
The recommended approach is to deploy APISIX with AWS CDK on AWS Fargate which helps you decouple the APISIX layer and the upstream layer on top of a fully-managed and secure serverless container compute environment with autoscaling capabilities.
See this guide by Pahud Hsieh and learn how to provision the recommended architecture 100% in AWS CDK.
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.
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.
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.
APISIX enriches the CNCF API Gateway Landscape:
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.
See CONTRIBUTING for details on submitting patches and the contribution workflow.
inspired by Kong and Orange.