yzeng25 commented on a change in pull request #4546: URL: https://github.com/apache/apisix/pull/4546#discussion_r664394905
########## File path: docs/zh/latest/getting-started.md ########## @@ -243,27 +256,31 @@ $ curl "http://127.0.0.1:9080/apisix/admin/routes/1"; -H "X-API-KEY: edd1c9f03433 现在您可以使用以下命令来调用路由： ```bash -$ curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo¶m2=bar"; -H "apikey: key-of-john" +curl -i -X GET "http://127.0.0.1:9080/samplePrefix/get?param1=foo¶m2=bar"; -H "apikey: key-of-john" ``` -### APISIX Dashboard（控制台） +### APISIX Dashboard Apache APISIX 提供了一个 [Dashboard](https://github.com/apache/apisix-dashboard)，让我们的操作更直观更轻松。  -### 故障排查 +:::note 注意 +APISIX Dashboard 目前仍然是一个实验性功能。 +::: + +### 常见问题排查 - 确保所需的所有端口（**默认的 9080/9443/2379**）未被其他系统/进程使用。 下面是终止正在侦听特定端口（基于 unix 的系统）的进程的命令。 ```bash - $ sudo fuser -k 9443/tcp + sudo fuser -k 9443/tcp ``` -- 如果 Docker 容器持续不断地重启/失败，请登录容器并观察日志以诊断问题。 +- 如果 Docker 容器持续不断地重启失败，请登录容器并观察日志以诊断问题。 Review comment: fixed ########## File path: docs/zh/latest/getting-started.md ########## @@ -21,17 +21,29 @@ title: 快速入门指南 # --> -本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。 +## 概述 -另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。 +本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。 Review comment: > How about using a numbered list? e.g > > 1. xx > 2. xx > 3. xx Good point, will do ########## File path: docs/zh/latest/getting-started.md ########## @@ -21,17 +21,29 @@ title: 快速入门指南 # --> -本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。 +## 概述 -另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。 +本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。 -**Request** +除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。 + +我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。 + +**请求内容** + +请求 URL 由以下这些参数构成： + +- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议 +- Port：即端口，这里使用的`80`端口。 +- Host：即宿主机，这里的主机是`httpbin.org` +- URI/Path：`/get` Review comment: Is it a path or a URI? It is written this way before the change. Please clarify. ########## File path: docs/zh/latest/getting-started.md ########## @@ -21,17 +21,29 @@ title: 快速入门指南 # --> -本指南旨在让大家入门 Apache APISIX，我们将配置一个对外提供公共 API 的服务，并由 API key 进行访问保护。 +## 概述 -另外，我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。 +本文是 Apache APISIX 的快速入门指南。快速入门分为三个步骤：首先通过[Docker](https://www.docker.com/) 和 [Docker Compose](https://docs.docker.com/compose/) 安装 Apache APISIX，然后创建路由并绑定后端服务，最后使用命令行语句`curl`验证绑定之后返回的结果是否符合预期。 -**Request** +除此之外，本文也提供了 Apache APISIX 的一些进阶操作技巧，包括：添加身份验证、为路由添加前缀、使用 APISIX Dashboard以及常见问题排查。 + +我们将以下面的 `echo` 端点为例，它将返回我们传递的参数。 + +**请求内容** + +请求 URL 由以下这些参数构成： + +- Protocol：即网络传输协议，这里使用的是最常见的HTTP协议 +- Port：即端口，这里使用的`80`端口。 +- Host：即宿主机，这里的主机是`httpbin.org` +- URI/Path：`/get` Review comment: Fixed, Path. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
