From 2a32f13824c0cc8e359feedd23e537422af3b28c Mon Sep 17 00:00:00 2001 From: Xunzhuo Date: Tue, 23 Nov 2021 09:05:29 +0800 Subject: [PATCH] docs(style): fix non-standard spaces between letters (#5566) --- docs/zh/latest/FAQ.md | 20 ++++++------- .../latest/architecture-design/debug-mode.md | 2 +- docs/zh/latest/architecture-design/route.md | 2 +- .../zh/latest/architecture-design/upstream.md | 18 ++++++------ docs/zh/latest/certificate.md | 8 +++--- docs/zh/latest/control-api.md | 2 +- docs/zh/latest/debug-function.md | 4 +-- docs/zh/latest/discovery.md | 2 +- docs/zh/latest/discovery/nacos.md | 2 +- docs/zh/latest/getting-started.md | 16 +++++------ docs/zh/latest/how-to-build.md | 16 +++++------ docs/zh/latest/mtls.md | 2 +- docs/zh/latest/plugin-develop.md | 4 +-- docs/zh/latest/plugins/api-breaker.md | 10 +++---- .../zh/latest/plugins/consumer-restriction.md | 6 ++-- docs/zh/latest/plugins/cors.md | 2 +- docs/zh/latest/plugins/dubbo-proxy.md | 4 +-- docs/zh/latest/plugins/echo.md | 2 +- docs/zh/latest/plugins/error-log-logger.md | 4 +-- docs/zh/latest/plugins/fault-injection.md | 2 +- docs/zh/latest/plugins/hmac-auth.md | 4 +-- docs/zh/latest/plugins/ip-restriction.md | 4 +-- docs/zh/latest/plugins/jwt-auth.md | 4 +-- docs/zh/latest/plugins/kafka-logger.md | 6 ++-- docs/zh/latest/plugins/key-auth.md | 4 +-- docs/zh/latest/plugins/limit-count.md | 6 ++-- docs/zh/latest/plugins/limit-req.md | 20 ++++++------- docs/zh/latest/plugins/mqtt-proxy.md | 2 +- docs/zh/latest/plugins/openid-connect.md | 10 +++---- docs/zh/latest/plugins/prometheus.md | 4 +-- docs/zh/latest/plugins/proxy-cache.md | 12 ++++---- docs/zh/latest/plugins/proxy-mirror.md | 2 +- docs/zh/latest/plugins/proxy-rewrite.md | 6 ++-- docs/zh/latest/plugins/redirect.md | 2 +- docs/zh/latest/plugins/request-id.md | 2 +- docs/zh/latest/plugins/response-rewrite.md | 6 ++-- docs/zh/latest/plugins/skywalking-logger.md | 2 +- docs/zh/latest/plugins/sls-logger.md | 20 ++++++------- docs/zh/latest/plugins/syslog.md | 10 +++---- docs/zh/latest/plugins/tcp-logger.md | 14 +++++----- docs/zh/latest/plugins/traffic-split.md | 28 +++++++++---------- docs/zh/latest/plugins/ua-restriction.md | 4 +-- docs/zh/latest/plugins/udp-logger.md | 2 +- docs/zh/latest/plugins/uri-blocker.md | 10 +++---- docs/zh/latest/plugins/wolf-rbac.md | 2 +- docs/zh/latest/plugins/zipkin.md | 4 +-- docs/zh/latest/profile.md | 6 ++-- docs/zh/latest/router-radixtree.md | 6 ++-- docs/zh/latest/stand-alone.md | 2 +- docs/zh/latest/stream-proxy.md | 4 +-- 50 files changed, 168 insertions(+), 168 deletions(-) diff --git a/docs/zh/latest/FAQ.md b/docs/zh/latest/FAQ.md index 742a215a..2f245e27 100644 --- a/docs/zh/latest/FAQ.md +++ b/docs/zh/latest/FAQ.md @@ -27,7 +27,7 @@ title: 常见问题 ## APISIX 和其他的 API 网关有什么不同之处？ -APISIX 基于 etcd 来完成配置的保存和同步，而不是 postgres 或者 MySQL 这类关系型数据库。 +APISIX 基于 etcd 来完成配置的保存和同步，而不是 PostgreSQL 或者 MySQL 这类关系型数据库。 这样不仅去掉了轮询，让代码更加的简洁，配置同步也更加实时。同时系统也不会存在单点，可用性更高。 另外，APISIX 具备动态路由和插件热加载，特别适合微服务体系下的 API 管理。 @@ -46,7 +46,7 @@ APISIX 是当前性能最好的 API 网关，单核 QPS 达到 2.3 万，平均 当然可以，APISIX 提供了灵活的自定义插件，方便开发者和企业编写自己的逻辑。 -[如何开发插件](plugin-develop.md) +具体可参考：[如何开发插件](plugin-develop.md) ## 我们为什么选择 etcd 作为配置中心？ @@ -170,7 +170,7 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f03433 }' ``` -3. 使用`serverless`插件： +3. 使用 `serverless` 插件： ```shell curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' @@ -213,18 +213,18 @@ Server: APISIX web server ## 如何修改日志等级 -默认的 APISIX 日志等级为`warn`，如果需要查看`core.log.info`的打印结果需要将日志等级调整为`info`。 +默认的 APISIX 日志等级为 `warn`，如果需要查看 `core.log.info` 的打印结果需要将日志等级调整为 `info`。 具体步骤： -1、修改 conf/config.yaml 中的 `nginx_config` 配置参数`error_log_level: "warn"` 为 `error_log_level: "info"`。 +1、修改 conf/config.yaml 中的 `nginx_config` 配置参数 `error_log_level: "warn"` 为 `error_log_level: "info"`。 ```yaml nginx_config: error_log_level: "info" ``` -2、重启抑或 reload APISIX +2、重启或 reload APISIX 之后便可以在 logs/error.log 中查看到 info 的日志了。 @@ -238,7 +238,7 @@ Apache APISIX 的插件支持热加载。 默认情况下，APISIX 在处理 HTTP 请求时只监听 9080 端口。如果你想让 APISIX 监听多个端口，你需要修改配置文件中的相关参数，具体步骤如下： -1. 修改 `conf/config.yaml` 中 HTTP 端口监听的参数`node_listen`，示例： +1. 修改 `conf/config.yaml` 中 HTTP 端口监听的参数 `node_listen`，示例： ``` apisix: @@ -248,7 +248,7 @@ Apache APISIX 的插件支持热加载。 - 9082 ``` - 处理 HTTPS 请求也类似，修改`conf/config.yaml`中 HTTPS 端口监听的参数`ssl.listen_port`，示例： + 处理 HTTPS 请求也类似，修改 `conf/config.yaml` 中 HTTPS 端口监听的参数 `ssl.listen_port`，示例： ``` apisix: @@ -268,7 +268,7 @@ etcd 提供订阅接口用于监听指定关键字、目录是否发生变更（ APISIX 主要使用 [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) 监视目录内容变更： * 如果监听目录没有数据更新：该调用会被阻塞，直到超时或其他错误返回。 -* 如果监听目录有数据更新：etcd 将立刻返回订阅(毫秒级)到的新数据，APISIX 将它更新到内存缓存。 +* 如果监听目录有数据更新：etcd 将立刻返回订阅（毫秒级）到的新数据，APISIX 将它更新到内存缓存。 借助 etcd 增量通知毫秒级特性，APISIX 也就完成了毫秒级的配置同步。 @@ -407,7 +407,7 @@ HTTP/1.1 404 Not Found ## upstream 节点是否支持配置 [FQDN](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) 地址? -这是支持的，下面是一个 `FQDN` 为 `httpbin.default.svc.cluster.local`(一个 Kubernetes Service) 的示例： +这是支持的，下面是一个 `FQDN` 为 `httpbin.default.svc.cluster.local`（一个 Kubernetes Service） 的示例： ```shell curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' diff --git a/docs/zh/latest/architecture-design/debug-mode.md b/docs/zh/latest/architecture-design/debug-mode.md index a4e7692d..a3350644 100644 --- a/docs/zh/latest/architecture-design/debug-mode.md +++ b/docs/zh/latest/architecture-design/debug-mode.md @@ -32,7 +32,7 @@ basic: 注意：在 APISIX 2.10 之前，开启基本调试模式曾经是设置 `conf/config.yaml` 中的 `apisix.enable_debug` 为 `true`。 -比如对 `/hello` 开启了 `limit-conn`和`limit-count`插件，这时候应答头中会有 `Apisix-Plugins: limit-conn, limit-count`。 +比如对 `/hello` 开启了 `limit-conn` 和 `limit-count` 插件，这时候应答头中会有 `Apisix-Plugins: limit-conn, limit-count`。 ```shell $ curl http://127.0.0.1:1984/hello -i diff --git a/docs/zh/latest/architecture-design/route.md b/docs/zh/latest/architecture-design/route.md index 18ddc9ec..32e85bc1 100644 --- a/docs/zh/latest/architecture-design/route.md +++ b/docs/zh/latest/architecture-design/route.md @@ -24,7 +24,7 @@ title: Route Route 字面意思就是路由，通过定义一些规则来匹配客户端的请求，然后根据匹配结果加载并执行相应的 插件，并把请求转发给到指定 Upstream。 -Route 中主要包含三部分内容：匹配规则(比如 uri、host、remote_addr 等)，插件配置(限流限速等)和上游信息。 +Route 中主要包含三部分内容：匹配规则（比如 uri、host、remote_addr 等），插件配（限流限速等）和上游信息。 请看下图示例，是一些 Route 规则的实例，当某些属性值相同时，图中用相同颜色标识。 ![路由示例](../../../assets/images/routes-example.png) diff --git a/docs/zh/latest/architecture-design/upstream.md b/docs/zh/latest/architecture-design/upstream.md index 3941410a..bf97b8ec 100644 --- a/docs/zh/latest/architecture-design/upstream.md +++ b/docs/zh/latest/architecture-design/upstream.md @@ -32,7 +32,7 @@ Upstream 的配置可以被直接绑定在指定 `Route` 中，也可以被绑 ### 配置参数 -APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上游做主被动健康检查、重试等逻辑，具体看这个[链接](../admin-api.md#upstream)。 +APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上游做主被动健康检查、重试等逻辑，具体看这个 [链接](../admin-api.md#upstream)。 创建上游对象用例： @@ -119,9 +119,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13 }' ``` -更多细节可以参考[健康检查的文档](../health-check.md)。 +更多细节可以参考 [健康检查的文档](../health-check.md)。 -下面是几个使用不同`hash_on`类型的配置示例： +下面是几个使用不同 `hash_on` 类型的配置示例： #### Consumer @@ -139,7 +139,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1 }' ``` -新建路由，打开`key-auth`插件认证，`upstream`的`hash_on`类型为`consumer`： +新建路由，打开 `key-auth` 插件认证，`upstream` 的 `hash_on` 类型为 `consumer`： ```shell curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' @@ -159,7 +159,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13 }' ``` -测试请求，认证通过后的`consumer_name`将作为负载均衡哈希算法的哈希值： +测试请求，认证通过后的 `consumer_name` 将作为负载均衡哈希算法的哈希值： ```shell curl http://127.0.0.1:9080/server_port -H "apikey: auth-jack" @@ -167,7 +167,7 @@ curl http://127.0.0.1:9080/server_port -H "apikey: auth-jack" ##### Cookie -新建路由和`Upstream`，`hash_on`类型为`cookie`： +新建路由和 `Upstream`，`hash_on` 类型为 `cookie`： ```shell curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' @@ -185,7 +185,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13 }' ``` -客户端请求携带`Cookie`： +客户端请求携带 `Cookie`： ```shell curl http://127.0.0.1:9080/hash_on_cookie -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -H "Cookie: sid=3c183a30cffcda1408daf1c61d47b274" @@ -193,7 +193,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13 ##### Header -新建路由和`Upstream`，`hash_on`类型为`header`， `key`为`content-type`： +新建路由和 `Upstream`，`hash_on` 类型为 `header`，`key` 为 `content-type`： ```shell curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' @@ -211,7 +211,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13 }' ``` -客户端请求携带`content-type`的`header`： +客户端请求携带 `content-type` 的 `header`： ```shell curl http://127.0.0.1:9080/hash_on_header -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -H "Content-Type: application/json" diff --git a/docs/zh/latest/certificate.md b/docs/zh/latest/certificate.md index 85bb53c6..d84db1b9 100644 --- a/docs/zh/latest/certificate.md +++ b/docs/zh/latest/certificate.md @@ -23,7 +23,7 @@ title: 证书 `APISIX` 支持通过 TLS 扩展 SNI 实现加载特定的 SSL 证书以实现对 https 的支持。 -SNI(Server Name Indication)是用来改善 SSL 和 TLS 的一项特性，它允许客户端在服务器端向其发送证书之前向服务器端发送请求的域名，服务器端根据客户端请求的域名选择合适的SSL证书发送给客户端。 +SNI(Server Name Indication)是用来改善 SSL 和 TLS 的一项特性，它允许客户端在服务器端向其发送证书之前向服务器端发送请求的域名，服务器端根据客户端请求的域名选择合适的 SSL 证书发送给客户端。 ### 单一域名指定 @@ -105,8 +105,8 @@ curl --resolve 'test.com:9443:127.0.0.1' https://test.com:9443/hello -vvv ### 泛域名 -一个 SSL 证书的域名也可能包含泛域名，如`*.test.com`，它代表所有以`test.com`结尾的域名都可以使用该证书。 -比如`*.test.com`，可以匹配 `www.test.com`、`mail.test.com`。 +一个 SSL 证书的域名也可能包含泛域名，如 `*.test.com`，它代表所有以 `test.com` 结尾的域名都可以使用该证书。 +比如 `*.test.com`，可以匹配 `www.test.com`、`mail.test.com`。 看下面这个例子，请注意我们把 `*.test.com` 作为 sni 传递进来: @@ -150,7 +150,7 @@ curl --resolve 'www.test.com:9443:127.0.0.1' https://www.test.com:9443/hello -v ### 多域名的情况 -如果一个 SSL 证书包含多个独立域名，比如`www.test.com`和`mail.test.com`， +如果一个 SSL 证书包含多个独立域名，比如 `www.test.com` 和 `mail.test.com`， 你可以把它们都放入 `snis` 数组中，就像这样： ```json diff --git a/docs/zh/latest/control-api.md b/docs/zh/latest/control-api.md index acd2b02c..5791b11e 100644 --- a/docs/zh/latest/control-api.md +++ b/docs/zh/latest/control-api.md @@ -154,7 +154,7 @@ APISIX 中一些插件添加了自己的 control API。如果你对他们感兴 每个 entry 包含以下字段： * src_type：表示 health checker 的来源。值是 `[routes,services,upstreams]` 其中之一 -* src_id：表示创建 health checker 的对象的id。例如，假设 id 为 1 的 Upstream 对象创建了一个 health checker，那么 `src_type` 就是 `upstreams`，`src_id` 就是 1 +* src_id：表示创建 health checker 的对象的 id。例如，假设 id 为 1 的 Upstream 对象创建了一个 health checker，那么 `src_type` 就是 `upstreams`，`src_id` 就是 1 * name： 表示 health checker 的名称 * nodes： health checker 的目标节点 * healthy_nodes： 表示 health checker 检测到的健康节点 diff --git a/docs/zh/latest/debug-function.md b/docs/zh/latest/debug-function.md index 539e67c2..e214ebe4 100644 --- a/docs/zh/latest/debug-function.md +++ b/docs/zh/latest/debug-function.md @@ -23,7 +23,7 @@ title: 调试功能 ## `5xx` 响应状态码 -500、502、503等类似的 `5xx` 状态码，是由于服务器错误而响应的状态码，当一个请求出现 `5xx` 状态码时；它可能来源于 `APISIX` 或 `Upstream` 。如何识别这些响应状态码的来源，是一件很有意义的事，它能够快速的帮助我们确定问题的所在。 +500、502、503 等类似的 `5xx` 状态码，是由于服务器错误而响应的状态码，当一个请求出现 `5xx` 状态码时；它可能来源于 `APISIX` 或 `Upstream` 。如何识别这些响应状态码的来源，是一件很有意义的事，它能够快速的帮助我们确定问题的所在。 ## 如何识别 `5xx` 响应状态码的来源 @@ -31,7 +31,7 @@ title: 调试功能 ## 示例 -示例1：`502` 响应状态码来源于 `Upstream` (IP地址不可用) +示例1：`502` 响应状态码来源于 `Upstream` (IP 地址不可用) ```shell $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' diff --git a/docs/zh/latest/discovery.md b/docs/zh/latest/discovery.md index 0466cb8b..c5cfda7c 100644 --- a/docs/zh/latest/discovery.md +++ b/docs/zh/latest/discovery.md @@ -206,7 +206,7 @@ discovery: ## upstream 配置 -APISIX 是通过 `upstream.discovery_type`选择使用的服务发现， `upstream.service_name` 与注册中心的服务名进行关联。下面是将 URL 为 "/user/\*" 的请求路由到注册中心名为 "USER-SERVICE" 的服务上例子： +APISIX 是通过 `upstream.discovery_type` 选择使用的服务发现，`upstream.service_name` 与注册中心的服务名进行关联。下面是将 URL 为 "/user/\*" 的请求路由到注册中心名为 "USER-SERVICE" 的服务上例子： ```shell $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' diff --git a/docs/zh/latest/discovery/nacos.md b/docs/zh/latest/discovery/nacos.md index ddec7908..a251e825 100644 --- a/docs/zh/latest/discovery/nacos.md +++ b/docs/zh/latest/discovery/nacos.md @@ -31,7 +31,7 @@ Nacos 服务发现模块目前是实验性的。 ### Nacos 配置 -在文件 `conf/config.yaml` 中添加以下配置到： +在文件 `conf/config.yaml` 中添加以下配置到： ```yaml discovery: diff --git a/docs/zh/latest/getting-started.md b/docs/zh/latest/getting-started.md index 4cc042a8..b7c996d0 100644 --- a/docs/zh/latest/getting-started.md +++ b/docs/zh/latest/getting-started.md @@ -40,8 +40,8 @@ title: 快速入门指南 - Protocol：即网络传输协议，示例中使用的是最常见的 `HTTP` 协议。 - Port：即端口，示例中使用的 `80` 端口。 - Host：即宿主机，示例中的主机是 `httpbin.org`。 -- Path：即路径，示例中的路径是`/get`。 -- Query Parameters：即查询字符串，这里有两个字符串，分别是`foo1`和`foo2`。 +- Path：即路径，示例中的路径是 `/get`。 +- Query Parameters：即查询字符串，这里有两个字符串，分别是 `foo1` 和 `foo2`。 运行以下命令，发送请求： @@ -70,9 +70,9 @@ curl --location --request GET "http://httpbin.org/get?foo1=bar1&foo2=bar2" ## 前提条件 -- 已安装[Docker Compose 组件](https://docs.docker.com/compose/)。 +- 已安装 [Docker Compose 组件](https://docs.docker.com/compose/)。 -- 本文使用 [curl](https://curl.se/docs/manpage.html) 命令行进行 API 测试。您也可以使用其他工具例如 [Postman](https://www.postman.com/)等，进行测试。 +- 本文使用 [curl](https://curl.se/docs/manpage.html) 命令行进行 API 测试。您也可以使用其他工具例如 [Postman](https://www.postman.com/) 等，进行测试。