You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/05/12 01:58:58 UTC
[GitHub] [apisix] juzhiyuan commented on a diff in pull request #7022: docs: update Chinese getting started doc
juzhiyuan commented on code in PR #7022:
URL: https://github.com/apache/apisix/pull/7022#discussion_r870878662
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
Review Comment:
```suggestion
Apache APISIX 是 Apache 软件基金会下的云原生 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布（金丝雀发布）、服务熔断、身份认证、可观测性等丰富的流量管理功能。我们可以使用 Apache APISIX 来处理传统的南北向流量，也可以处理服务间的东西向流量。同时，它也支持作为 [K8s Ingress Controller](https://github.com/apache/apisix-ingress-controller) 来使用。
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
Review Comment:
We don't need to mention `APISIX` always here :)
```suggestion
### 主要特性
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
Review Comment:
```suggestion
- 精细化路由：APISIX 支持使用 [NGINX 内置变量](http://nginx.org/en/docs/varindex.html)做为路由的匹配条件，你可以自定义匹配函数来过滤路由。
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
+- 运维友好：APISIX 因其对 DevOps 团队的操作友好而闻名。它可以与以下工具和平台集成：[HashiCorp Vault](./plugins/jwt-auth.md#usage-with-hashicorp-vault)、[Zipkin](./plugins/zipkin.md)、[Apache SkyWalking](./plugins/skywalking.md)、[Consul](./discovery/consul_kv.md)、[Nacos](./discovery/nacos.md)、[Eureka](./discovery.md)。通过 [APISIX Dashboard](/docs/dashboard/USER_GUIDE)，运维人员可以通过友好且直观的 UI 配置 APISIX。
Review Comment:
`APISIX 因其对 DevOps 团队的操作友好而闻名` 🤣🤣🤣
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
+- 运维友好：APISIX 因其对 DevOps 团队的操作友好而闻名。它可以与以下工具和平台集成：[HashiCorp Vault](./plugins/jwt-auth.md#usage-with-hashicorp-vault)、[Zipkin](./plugins/zipkin.md)、[Apache SkyWalking](./plugins/skywalking.md)、[Consul](./discovery/consul_kv.md)、[Nacos](./discovery/nacos.md)、[Eureka](./discovery.md)。通过 [APISIX Dashboard](/docs/dashboard/USER_GUIDE)，运维人员可以通过友好且直观的 UI 配置 APISIX。
+- 多语言插件支持：APISIX 支持多种开发语言进行插件开发，开发人员可以选择擅长语言的 SDK 开发自定义插件。
+
+## 主要概念
+
+下图为 APISIX 的架构：
+
+
+
+下表是本文涉及到的 APISIX 的主要概念和组件：
+
+| 概念/组件 | 描述 |
+|-------------|--------------------------------------------------------------------------------------------------|
+| Route | 通过路由定义规则来匹配客户端请求，根据匹配结果加载并执行相应的插件，最后把请求转发给到指定的上游应用。 |
+| Upstream | 上游的作用是按照配置规则对服务节点进行负载均衡，它的地址信息可以直接配置到路由或服务上。 |
+| Admin API | 用户通过该组件可以控制 APISIX 实例的 API。 |
Review Comment:
```suggestion
| Admin API | 用户通过 AdminAPI 可以控制 APISIX 实例。 |
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -126,17 +191,13 @@ curl "http://127.0.0.1:9080/apisix/admin/services/" -H 'X-API-KEY: edd1c9f034335
}
```
-## 第二步：创建路由
-
-您现在已经拥有一个运行中的 Apache APISIX 实例了！接下来，让我们来创建一个路由（Route）。
-
-### 工作原理
+## 创建路由
-Apache APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 可供我们使用。在本文中，我们使用 Admin API 来做演示。
+现在你已经拥有一个正在运行的 APISIX 实例了！接下来，让我们来创建一个路由。
-我们可以创建一个 [Route](./terminology/route.md) 并与上游服务（通常也被称为 [Upstream](./terminology/upstream.md) 或后端服务）绑定，当一个 `请求（Request）` 到达 Apache APISIX 时，Apache APISIX 就会明白这个请求应该转发到哪个上游服务中。
+APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 供用户使用。在下述示例中，我们将使用 Admin API 创建一个 [Route](./terminology/route.md) 并与 [Upstream](./terminology/upstream.md) 绑定，当一个请求到达 APISIX 时，APISIX 会将请求转发到指定的上游服务中。
Review Comment:
One suggestion: we need to unify when to use `Route`, and when to use `路由`。
##########
docs/zh/latest/getting-started.md:
##########
@@ -68,51 +109,75 @@ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
}
```
-## 前提条件
+## 安装 APISIX
-- 已安装 [Docker Compose 组件](https://docs.docker.com/compose/)。
+在本文中我们将使用 Docker 安装 APISIX 并启用 [Admin API](./admin-api.md)。
-- 本文使用 [curl](https://curl.se/docs/manpage.html) 命令行进行 API 测试。您也可以使用其他工具例如 [Postman](https://www.postman.com/) 等，进行测试。
+首先，通过 `git` 命令克隆 [apisix-docker](https://github.com/apache/apisix-docker) 仓库：
-<!--
-#
-# In addition to the basic Markdown syntax, we use remark-admonitions
-# alongside MDX to add support for admonitions. Admonitions are wrapped
-# by a set of 3 colons.
-# Please refer to https://docusaurus.io/docs/next/markdown-features/admonitions
-# for more detail.
-#
--->
+```bash
+git clone https://github.com/apache/apisix-docker.git
+cd apisix-docker/example
+```
+
+现在你可以 `docker-compose` 启动 APISIX。
Review Comment:
```suggestion
现在你可以通过 `docker-compose` 启动 APISIX 实例。
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
Review Comment:
```suggestion
- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。请访问[为什么 Apache APISIX 选择 Nginx + Lua 这个技术栈？](https://apisix.apache.org/zh/blog/2021/08/25/why-apache-apisix-chose-nginx-and-lua/)以了解实现原理。
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
+- 运维友好：APISIX 因其对 DevOps 团队的操作友好而闻名。它可以与以下工具和平台集成：[HashiCorp Vault](./plugins/jwt-auth.md#usage-with-hashicorp-vault)、[Zipkin](./plugins/zipkin.md)、[Apache SkyWalking](./plugins/skywalking.md)、[Consul](./discovery/consul_kv.md)、[Nacos](./discovery/nacos.md)、[Eureka](./discovery.md)。通过 [APISIX Dashboard](/docs/dashboard/USER_GUIDE)，运维人员可以通过友好且直观的 UI 配置 APISIX。
+- 多语言插件支持：APISIX 支持多种开发语言进行插件开发，开发人员可以选择擅长语言的 SDK 开发自定义插件。
+
+## 主要概念
+
+下图为 APISIX 的架构：
Review Comment:
```suggestion
下图为 Apache APISIX 的架构：
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
+- 运维友好：APISIX 因其对 DevOps 团队的操作友好而闻名。它可以与以下工具和平台集成：[HashiCorp Vault](./plugins/jwt-auth.md#usage-with-hashicorp-vault)、[Zipkin](./plugins/zipkin.md)、[Apache SkyWalking](./plugins/skywalking.md)、[Consul](./discovery/consul_kv.md)、[Nacos](./discovery/nacos.md)、[Eureka](./discovery.md)。通过 [APISIX Dashboard](/docs/dashboard/USER_GUIDE)，运维人员可以通过友好且直观的 UI 配置 APISIX。
+- 多语言插件支持：APISIX 支持多种开发语言进行插件开发，开发人员可以选择擅长语言的 SDK 开发自定义插件。
+
+## 主要概念
+
+下图为 APISIX 的架构：
+
+
+
+下表是本文涉及到的 APISIX 的主要概念和组件：
+
+| 概念/组件 | 描述 |
+|-------------|--------------------------------------------------------------------------------------------------|
+| Route | 通过路由定义规则来匹配客户端请求，根据匹配结果加载并执行相应的插件，最后把请求转发给到指定的上游应用。 |
+| Upstream | 上游的作用是按照配置规则对服务节点进行负载均衡，它的地址信息可以直接配置到路由或服务上。 |
+| Admin API | 用户通过该组件可以控制 APISIX 实例的 API。 |
+
+## 前提条件
+
+在开始使用 APISIX 之前，请确保你已经安装以下应用：
+
+- [Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/)。
+- [curl](https://curl.se/docs/manpage.html) 用于测试 API。你也可以使用 [Hoppscotch](https://hoppscotch.io/) 之类的工具。
+- 本文使用的上游服务是 [httpbin.org](https://httpbin.org)，你可以使用它进行测试。它是一个返回服务，这意味着它将返回我们在请求中传递的参数。
+
+**请求内容：**
请求 URL 由以下这些参数构成：
Review Comment:
```suggestion
请求 URL 由以下参数构成：
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -68,51 +109,75 @@ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2"
}
```
-## 前提条件
+## 安装 APISIX
-- 已安装 [Docker Compose 组件](https://docs.docker.com/compose/)。
+在本文中我们将使用 Docker 安装 APISIX 并启用 [Admin API](./admin-api.md)。
Review Comment:
```suggestion
我们将使用 Docker 安装 Apache APISIX 并启用 [Admin API](./admin-api.md)。
```
##########
docs/zh/latest/getting-started.md:
##########
@@ -126,17 +191,13 @@ curl "http://127.0.0.1:9080/apisix/admin/services/" -H 'X-API-KEY: edd1c9f034335
}
```
-## 第二步：创建路由
-
-您现在已经拥有一个运行中的 Apache APISIX 实例了！接下来，让我们来创建一个路由（Route）。
-
-### 工作原理
+## 创建路由
-Apache APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 可供我们使用。在本文中，我们使用 Admin API 来做演示。
+现在你已经拥有一个正在运行的 APISIX 实例了！接下来，让我们来创建一个路由。
-我们可以创建一个 [Route](./terminology/route.md) 并与上游服务（通常也被称为 [Upstream](./terminology/upstream.md) 或后端服务）绑定，当一个 `请求（Request）` 到达 Apache APISIX 时，Apache APISIX 就会明白这个请求应该转发到哪个上游服务中。
+APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 供用户使用。在下述示例中，我们将使用 Admin API 创建一个 [Route](./terminology/route.md) 并与 [Upstream](./terminology/upstream.md) 绑定，当一个请求到达 APISIX 时，APISIX 会将请求转发到指定的上游服务中。
Review Comment:
I would prefer to always use `Route, Upstream, Service`, even in Chinese, as they're more straightforward.
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
+- 运维友好：APISIX 因其对 DevOps 团队的操作友好而闻名。它可以与以下工具和平台集成：[HashiCorp Vault](./plugins/jwt-auth.md#usage-with-hashicorp-vault)、[Zipkin](./plugins/zipkin.md)、[Apache SkyWalking](./plugins/skywalking.md)、[Consul](./discovery/consul_kv.md)、[Nacos](./discovery/nacos.md)、[Eureka](./discovery.md)。通过 [APISIX Dashboard](/docs/dashboard/USER_GUIDE)，运维人员可以通过友好且直观的 UI 配置 APISIX。
+- 多语言插件支持：APISIX 支持多种开发语言进行插件开发，开发人员可以选择擅长语言的 SDK 开发自定义插件。
+
+## 主要概念
+
+下图为 APISIX 的架构：
+
+
+
+下表是本文涉及到的 APISIX 的主要概念和组件：
+
+| 概念/组件 | 描述 |
+|-------------|--------------------------------------------------------------------------------------------------|
+| Route | 通过路由定义规则来匹配客户端请求，根据匹配结果加载并执行相应的插件，最后把请求转发给到指定的上游应用。 |
+| Upstream | 上游的作用是按照配置规则对服务节点进行负载均衡，它的地址信息可以直接配置到路由或服务上。 |
+| Admin API | 用户通过该组件可以控制 APISIX 实例的 API。 |
+
+## 前提条件
+
+在开始使用 APISIX 之前，请确保你已经安装以下应用：
+
+- [Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/)。
+- [curl](https://curl.se/docs/manpage.html) 用于测试 API。你也可以使用 [Hoppscotch](https://hoppscotch.io/) 之类的工具。
+- 本文使用的上游服务是 [httpbin.org](https://httpbin.org)，你可以使用它进行测试。它是一个返回服务，这意味着它将返回我们在请求中传递的参数。
Review Comment:
How about converting this NOTE to the `INFO` mark? (Not in this PR) AFAIK, some users don't know what's `httpbin` is and they will ignore this part usually 🤣
cc @hf400159 @navendu-pottekkat
##########
docs/zh/latest/getting-started.md:
##########
@@ -181,25 +242,9 @@ curl "http://127.0.0.1:9080/apisix/admin/upstreams/1" -H "X-API-KEY: edd1c9f0343
}'
```
-我们使用 `roundrobin` 作为负载均衡机制，并将 `httpbin.org:80` 设置为我们的上游服务，其 ID 为 `1`。更多字段信息，请参阅 [Admin API](./admin-api.md)。
+该上游配置与上一节配置在路由中的上游相同。同样使用了 `roundrobin` 作为负载均衡机制以及设置了 `httpbin.org:80` 为上游服务。为了将该上游绑定到路由我们把 `upstream_id` 设置为 `1`。更多字段信息，请参考 [Admin API](./admin-api.md)。
Review Comment:
People will get confused it's string or number 1 :)
##########
docs/zh/latest/getting-started.md:
##########
@@ -21,25 +26,61 @@ title: 快速入门指南
#
-->
-## 概述
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
-本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：
+本文将为你介绍 Apache APISIX 的概念、功能以及如何使用 APISIX。
-1. 通过 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX。
-1. 创建路由并绑定上游。
-1. 使用命令行语句 `curl` 验证绑定之后返回的结果是否符合预期。
+通过本文你可以了解到以下内容：
-除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard 以及常见问题排查。
+- Apache APISIX 是什么？
+- APISIX 的架构及主要概念。
+- 如何使用 Docker 安装并运行 APISIX。
+- 如何使用 Admin API 创建第一个路由并配置上游。
+- 如何使用 APISIX Dashboard。
+- 如何寻求帮助。
-我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。
+## Apache APISIX 是什么？
-**请求内容**
+Apache APISIX 是一个开源的云原生 API 网关，作为 API 网关，它兼具动态、实时、高性能等特点，提供了负载均衡、动态上游、灰度发布、服务熔断、身份认证、可观测性等丰富的流量管理功能。你可以使用 Apache APISIX 来处理传统的南北向流量，以及服务间的东西向流量，也可以当做 K8s Ingress controller 来使用。
+
+### APISIX 的功能
+
+- 多平台支持：APISIX 提供了多平台解决方案，它不但支持裸机运行，也支持在 Kubernetes 中使用，还支持与 AWS Lambda、Azure Function、Lua 函数和 Apache OpenWhisk 等云服务集成。
+- 全动态能力：APISIX 支持热加载，这意味着你不需要重启服务就可以更新 APISIX 的配置。
+- 精细化路由：APISIX 支持使用 NGINX 所有的内置变量做为路由的条件，你可以自定义匹配函数来过滤路由。
Review Comment:
`过滤路由` or `过滤请求`?
##########
docs/zh/latest/getting-started.md:
##########
@@ -126,17 +191,13 @@ curl "http://127.0.0.1:9080/apisix/admin/services/" -H 'X-API-KEY: edd1c9f034335
}
```
-## 第二步：创建路由
-
-您现在已经拥有一个运行中的 Apache APISIX 实例了！接下来，让我们来创建一个路由（Route）。
-
-### 工作原理
+## 创建路由
-Apache APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 可供我们使用。在本文中，我们使用 Admin API 来做演示。
+现在你已经拥有一个正在运行的 APISIX 实例了！接下来，让我们来创建一个路由。
-我们可以创建一个 [Route](./terminology/route.md) 并与上游服务（通常也被称为 [Upstream](./terminology/upstream.md) 或后端服务）绑定，当一个 `请求（Request）` 到达 Apache APISIX 时，Apache APISIX 就会明白这个请求应该转发到哪个上游服务中。
+APISIX 提供了强大的 [Admin API](./admin-api.md) 和 [Dashboard](https://github.com/apache/apisix-dashboard) 供用户使用。在下述示例中，我们将使用 Admin API 创建一个 [Route](./terminology/route.md) 并与 [Upstream](./terminology/upstream.md) 绑定，当一个请求到达 APISIX 时，APISIX 会将请求转发到指定的上游服务中。
Review Comment:
cc @navendu-pottekkat
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org