This is an automated email from the ASF dual-hosted git repository.
kayx23 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 08aafa560 docs: improve README with quickstart, AI Gateway section,
and TOC (#13677)
08aafa560 is described below
commit 08aafa560900f2f44670fe0ad76c9d6cc4e6bd09
Author: Ming Wen <[email protected]>
AuthorDate: Fri Jul 10 00:58:53 2026 +0800
docs: improve README with quickstart, AI Gateway section, and TOC (#13677)
* docs: improve README with quickstart, AI Gateway section, and TOC
* docs: clarify Admin API port and restore plugin-concept link
---
README.md | 115 ++++++++++++++++++++++++++++++++++++++++++--------------------
1 file changed, 79 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
index a61b52db4..8f3179d4d 100644
--- a/README.md
+++ b/README.md
@@ -23,32 +23,88 @@
[](https://github.com/apache/apisix/actions/workflows/build.yml)
[](https://github.com/apache/apisix/blob/master/LICENSE)
+[](https://github.com/apache/apisix/releases)
+[](https://github.com/apache/apisix/stargazers)
+[](https://hub.docker.com/r/apache/apisix)
[](https://github.com/apache/apisix/graphs/commit-activity)
-[](http://isitmaintained.com/project/apache/apisix
"Average time to resolve an issue")
-[](http://isitmaintained.com/project/apache/apisix
"Percentage of issues still open")
+[](https://github.com/apache/apisix/issues)
[](https://apisix.apache.org/slack)
**Apache APISIX** is a dynamic, real-time, high-performance API Gateway.
-APISIX API Gateway provides rich traffic management features such as load
balancing, dynamic upstream, canary release, circuit breaking, authentication,
observability, and more.
+APISIX API Gateway provides rich traffic management features such as load
balancing, dynamic upstream, canary release, circuit breaking, authentication,
observability, and more. You can use it to handle traditional north-south
traffic, as well as east-west traffic between services. It can also be used as
a [Kubernetes ingress
controller](https://github.com/apache/apisix-ingress-controller).
-APISIX can serve as an **[AI Gateway](https://apisix.apache.org/ai-gateway/)**
through its flexible plugin system, providing AI proxying, load balancing for
LLMs, retries and fallbacks, token-based rate limiting, and robust security to
ensure the efficiency and reliability of AI agents. APISIX also provides the
[`mcp-bridge`](https://apisix.apache.org/blog/2025/04/21/host-mcp-server-with-api-gateway/)
plugin to seamlessly convert stdio-based MCP servers to scalable HTTP SSE
services.
+## Table of Contents
-You can use APISIX API Gateway to handle traditional north-south traffic, as
well as east-west traffic between services. It can also be used as a [k8s
ingress controller](https://github.com/apache/apisix-ingress-controller).
+- [Why APISIX](#why-apisix)
+- [AI Gateway](#ai-gateway)
+- [Get Started](#get-started)
+- [Features](#features)
+- [Benchmark](#benchmark)
+- [Community](#community)
+- [User Stories](#user-stories)
+- [Who Uses APISIX API Gateway?](#who-uses-apisix-api-gateway)
+- [Logos](#logos)
+- [Acknowledgments](#acknowledgments)
+- [License](#license)
+
+## Why APISIX
+
+APISIX is built on top of NGINX and etcd. Compared with traditional API
gateways, APISIX has dynamic routing and hot-loading of plugins, which is
especially suitable for API management under a microservice architecture.
The technical architecture of Apache APISIX:
-## Community
+## AI Gateway
-- [Kindly Write a Review](https://www.g2.com/products/apache-apisix/reviews)
for APISIX in G2.
-- Mailing List: Mail to [email protected], follow the reply to
subscribe to the mailing list.
-- Slack Workspace - [invitation link](https://apisix.apache.org/slack) (Please
open an [issue](https://apisix.apache.org/docs/general/submit-issue) if this
link is expired), and then join the #apisix channel (Channels -> Browse
channels -> search for "apisix").
--  -
follow and interact with us using hashtag `#ApacheAPISIX`
-- [Documentation](https://apisix.apache.org/docs/)
-- [Discussions](https://github.com/apache/apisix/discussions)
-- [Blog](https://apisix.apache.org/blog)
+APISIX can serve as an **[AI Gateway](https://apisix.apache.org/ai-gateway/)**
through its flexible plugin system, providing:
+
+- **AI proxying** to route traffic to different LLM providers through a
unified interface.
+- **Load balancing, retries, and fallbacks** across multiple LLMs to ensure
the efficiency and reliability of AI agents.
+- **Token-based rate limiting** to control cost and protect upstream models.
+- **Robust security** for authentication, authorization, and traffic control
on AI workloads.
+
+APISIX also provides the
[`mcp-bridge`](https://apisix.apache.org/blog/2025/04/21/host-mcp-server-with-api-gateway/)
plugin to seamlessly convert stdio-based MCP servers to scalable HTTP SSE
services.
+
+## Get Started
+
+Install and run APISIX with a single command using the quickstart script
(requires [Docker](https://docs.docker.com/get-docker/)):
+
+```shell
+curl -sL https://run.api7.ai/apisix/quickstart | sh
+```
+
+This starts APISIX (listening on port `9080`) together with its etcd
configuration store. Verify it is running:
+
+```shell
+curl "http://127.0.0.1:9080"; --head | grep Server
+```
+
+Create your first route via the Admin API (port `9180`) to proxy requests to
an upstream service:
+
+```shell
+curl -i "http://127.0.0.1:9180/apisix/admin/routes/1"; -X PUT -d '
+{
+ "uri": "/get",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "httpbin.org:80": 1
+ }
+ }
+}'
+```
+
+Send a request through APISIX to confirm the route works:
+
+```shell
+curl "http://127.0.0.1:9080/get";
+```
+
+To learn more, follow the [Getting
Started](https://apisix.apache.org/docs/apisix/getting-started/) guide and the
[installation
documentation](https://apisix.apache.org/docs/apisix/installation-guide/) for
other deployment methods. To extend APISIX, see the [plugin development
guide](docs/en/latest/plugin-develop.md), the [plugin
concept](docs/en/latest/terminology/plugin.md), and the [REST Admin
API](docs/en/latest/admin-api.md) reference.
+
+For more documents, please refer to the [Apache APISIX Documentation
site](https://apisix.apache.org/docs/apisix/getting-started/).
## Features
@@ -162,29 +218,6 @@ A/B testing, canary release, blue-green deployment, limit
rate, defense against
- [Azure Functions](docs/en/latest/plugins/azure-functions.md): Seamless
integration with Azure Serverless Function as a dynamic upstream to proxy all
requests for a particular URI to the Microsoft Azure cloud.
- [Apache OpenWhisk](docs/en/latest/plugins/openwhisk.md): Seamless
integration with Apache OpenWhisk as a dynamic upstream to proxy all requests
for a particular URI to your own OpenWhisk cluster.
-## Get Started
-
-1. Installation
-
- Please refer to [install
documentation](https://apisix.apache.org/docs/apisix/installation-guide/).
-
-2. Getting started
-
- The getting started guide is a great way to learn the basics of APISIX.
Just follow the steps in [Getting
Started](https://apisix.apache.org/docs/apisix/getting-started/).
-
- Further, you can follow the documentation to try more
[plugins](docs/en/latest/plugins).
-
-3. Admin API
-
- Apache APISIX provides [REST Admin API](docs/en/latest/admin-api.md) to
dynamically control the Apache APISIX cluster.
-
-4. Plugin development
-
- You can refer to [plugin development
guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s
code implementation.
- Reading [plugin concept](docs/en/latest/terminology/plugin.md) would help
you learn more about the plugin.
-
-For more documents, please refer to [Apache APISIX Documentation
site](https://apisix.apache.org/docs/apisix/getting-started/)
-
## Benchmark
Using AWS's eight-core server, APISIX's QPS reaches 140,000 with a latency of
only 0.2 ms.
@@ -193,6 +226,16 @@ Using AWS's eight-core server, APISIX's QPS reaches
140,000 with a latency of on
[APISIX also works perfectly in AWS graviton3
C7g.](https://apisix.apache.org/blog/2022/06/07/installation-performance-test-of-apigateway-apisix-on-aws-graviton3)
+## Community
+
+- [Kindly Write a Review](https://www.g2.com/products/apache-apisix/reviews)
for APISIX in G2.
+- Mailing List: Mail to [email protected], follow the reply to
subscribe to the mailing list.
+- Slack Workspace - [invitation link](https://apisix.apache.org/slack) (Please
open an [issue](https://apisix.apache.org/docs/general/submit-issue) if this
link is expired), and then join the #apisix channel (Channels -> Browse
channels -> search for "apisix").
+-  -
follow and interact with us using hashtag `#ApacheAPISIX`
+- [Documentation](https://apisix.apache.org/docs/)
+- [Discussions](https://github.com/apache/apisix/discussions)
+- [Blog](https://apisix.apache.org/blog)
+
## User Stories
- [European eFactory Platform: API Security Gateway – Using APISIX in the
eFactory
Platform](https://www.efactory-project.eu/post/api-security-gateway-using-apisix-in-the-efactory-platform)
