Skip to content

Commit 873ed13

Browse files
committed
docs: improve README with quickstart, AI Gateway section, and TOC
1 parent a28d9bb commit 873ed13

1 file changed

Lines changed: 79 additions & 36 deletions

File tree

README.md

Lines changed: 79 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,88 @@
2323

2424
[![Build Status](https://github.com/apache/apisix/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/apache/apisix/actions/workflows/build.yml)
2525
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/apache/apisix/blob/master/LICENSE)
26+
[![GitHub release](https://img.shields.io/github/v/release/apache/apisix?color=blue)](https://github.com/apache/apisix/releases)
27+
[![GitHub stars](https://img.shields.io/github/stars/apache/apisix?style=flat&color=blue)](https://github.com/apache/apisix/stargazers)
28+
[![Docker Pulls](https://img.shields.io/docker/pulls/apache/apisix?color=blue)](https://hub.docker.com/r/apache/apisix)
2629
[![Commit activity](https://img.shields.io/github/commit-activity/m/apache/apisix)](https://github.com/apache/apisix/graphs/commit-activity)
27-
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/apache/apisix.svg)](http://isitmaintained.com/project/apache/apisix "Average time to resolve an issue")
28-
[![Percentage of issues still open](http://isitmaintained.com/badge/open/apache/apisix.svg)](http://isitmaintained.com/project/apache/apisix "Percentage of issues still open")
30+
[![GitHub issues](https://img.shields.io/github/issues/apache/apisix)](https://github.com/apache/apisix/issues)
2931
[![Slack](https://badgen.net/badge/Slack/Join%20Apache%20APISIX?icon=slack)](https://apisix.apache.org/slack)
3032

3133
**Apache APISIX** is a dynamic, real-time, high-performance API Gateway.
3234

33-
APISIX API Gateway provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, and more.
35+
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).
3436

35-
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.
37+
## Table of Contents
3638

37-
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).
39+
- [Why APISIX](#why-apisix)
40+
- [AI Gateway](#ai-gateway)
41+
- [Get Started](#get-started)
42+
- [Features](#features)
43+
- [Benchmark](#benchmark)
44+
- [Community](#community)
45+
- [User Stories](#user-stories)
46+
- [Who Uses APISIX API Gateway?](#who-uses-apisix-api-gateway)
47+
- [Logos](#logos)
48+
- [Acknowledgments](#acknowledgments)
49+
- [License](#license)
50+
51+
## Why APISIX
52+
53+
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.
3854

3955
The technical architecture of Apache APISIX:
4056

4157
![Technical architecture of Apache APISIX](docs/assets/images/apisix.png)
4258

43-
## Community
59+
## AI Gateway
4460

45-
- [Kindly Write a Review](https://www.g2.com/products/apache-apisix/reviews) for APISIX in G2.
46-
- Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe to the mailing list.
47-
- 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").
48-
- ![Twitter Follow](https://img.shields.io/twitter/follow/ApacheAPISIX?style=social) - follow and interact with us using hashtag `#ApacheAPISIX`
49-
- [Documentation](https://apisix.apache.org/docs/)
50-
- [Discussions](https://github.com/apache/apisix/discussions)
51-
- [Blog](https://apisix.apache.org/blog)
61+
APISIX can serve as an **[AI Gateway](https://apisix.apache.org/ai-gateway/)** through its flexible plugin system, providing:
62+
63+
- **AI proxying** to route traffic to different LLM providers through a unified interface.
64+
- **Load balancing, retries, and fallbacks** across multiple LLMs to ensure the efficiency and reliability of AI agents.
65+
- **Token-based rate limiting** to control cost and protect upstream models.
66+
- **Robust security** for authentication, authorization, and traffic control on AI workloads.
67+
68+
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.
69+
70+
## Get Started
71+
72+
Install and run APISIX with a single command using the quickstart script (requires [Docker](https://docs.docker.com/get-docker/)):
73+
74+
```shell
75+
curl -sL https://run.api7.ai/apisix/quickstart | sh
76+
```
77+
78+
This starts APISIX (listening on port `9080`) together with its etcd configuration store. Verify it is running:
79+
80+
```shell
81+
curl "http://127.0.0.1:9080" --head | grep Server
82+
```
83+
84+
Create your first route to proxy requests to an upstream service:
85+
86+
```shell
87+
curl -i "http://127.0.0.1:9180/apisix/admin/routes/1" -X PUT -d '
88+
{
89+
"uri": "/get",
90+
"upstream": {
91+
"type": "roundrobin",
92+
"nodes": {
93+
"httpbin.org:80": 1
94+
}
95+
}
96+
}'
97+
```
98+
99+
Send a request through APISIX to confirm the route works:
100+
101+
```shell
102+
curl "http://127.0.0.1:9080/get"
103+
```
104+
105+
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) and the [REST Admin API](docs/en/latest/admin-api.md) reference.
106+
107+
For more documents, please refer to the [Apache APISIX Documentation site](https://apisix.apache.org/docs/apisix/getting-started/).
52108

53109
## Features
54110

@@ -162,29 +218,6 @@ A/B testing, canary release, blue-green deployment, limit rate, defense against
162218
- [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.
163219
- [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.
164220

165-
## Get Started
166-
167-
1. Installation
168-
169-
Please refer to [install documentation](https://apisix.apache.org/docs/apisix/installation-guide/).
170-
171-
2. Getting started
172-
173-
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/).
174-
175-
Further, you can follow the documentation to try more [plugins](docs/en/latest/plugins).
176-
177-
3. Admin API
178-
179-
Apache APISIX provides [REST Admin API](docs/en/latest/admin-api.md) to dynamically control the Apache APISIX cluster.
180-
181-
4. Plugin development
182-
183-
You can refer to [plugin development guide](docs/en/latest/plugin-develop.md), and sample plugin `example-plugin`'s code implementation.
184-
Reading [plugin concept](docs/en/latest/terminology/plugin.md) would help you learn more about the plugin.
185-
186-
For more documents, please refer to [Apache APISIX Documentation site](https://apisix.apache.org/docs/apisix/getting-started/)
187-
188221
## Benchmark
189222

190223
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
193226

194227
[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)
195228

229+
## Community
230+
231+
- [Kindly Write a Review](https://www.g2.com/products/apache-apisix/reviews) for APISIX in G2.
232+
- Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe to the mailing list.
233+
- 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").
234+
- ![Twitter Follow](https://img.shields.io/twitter/follow/ApacheAPISIX?style=social) - follow and interact with us using hashtag `#ApacheAPISIX`
235+
- [Documentation](https://apisix.apache.org/docs/)
236+
- [Discussions](https://github.com/apache/apisix/discussions)
237+
- [Blog](https://apisix.apache.org/blog)
238+
196239
## User Stories
197240

198241
- [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)

0 commit comments

Comments
 (0)