mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-02 12:07:35 +08:00
docs(style): fix non-standard spaces between letters (#5566)
This commit is contained in:
Xunzhuo
GitHub
parent
db4ad744ea
commit
2a32f13824
@ -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 作为配置中心？
|
||||
|
||||
@ -224,7 +224,7 @@ nginx_config:
|
||||
error_log_level: "info"
|
||||
```
|
||||
|
||||
2、重启抑或 reload APISIX
|
||||
2、重启或 reload APISIX
|
||||
|
||||
之后便可以在 logs/error.log 中查看到 info 的日志了。
|
||||
|
||||
@ -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 '
|
||||
|
||||
@ -24,7 +24,7 @@ title: Route
|
||||
Route 字面意思就是路由，通过定义一些规则来匹配客户端的请求，然后根据匹配结果加载并执行相应的
|
||||
插件，并把请求转发给到指定 Upstream。
|
||||
|
||||
Route 中主要包含三部分内容：匹配规则(比如 uri、host、remote_addr 等)，插件配置(限流限速等)和上游信息。
|
||||
Route 中主要包含三部分内容：匹配规则（比如 uri、host、remote_addr 等），插件配（限流限速等）和上游信息。
|
||||
请看下图示例，是一些 Route 规则的实例，当某些属性值相同时，图中用相同颜色标识。
|
||||
|
||||
|
||||
|
||||
@ -75,7 +75,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
|
||||
}'
|
||||
```
|
||||
|
||||
这里以`route`为例(`service`的使用是同样的方法)，在指定的 `route` 上启用 `limit-req` 插件，并设置 `key_type` 为 `var_combination`。
|
||||
这里以 `route` 为例（`service` 的使用是同样的方法），在指定的 `route` 上启用 `limit-req` 插件，并设置 `key_type` 为 `var_combination`。
|
||||
|
||||
```shell
|
||||
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
|
||||
|
||||
@ -148,7 +148,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
|
||||
插件可以充当 OIDC 依赖方并重定向到身份提供者的授权端点以通过 OIDC 授权代码流程；
|
||||
请参阅 https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth 。
|
||||
一旦用户通过身份提供者进行身份验证，插件将代表用户从身份提供者获取和管理访问令牌和更多信息。
|
||||
该信息当前存储在会话 cookie 中，该插件将识别 cookie 并使用其中的信息，以避免再次执行认证流程。
|
||||
该信息当前存储在会话 Cookie 中，该插件将识别 Cookie 并使用其中的信息，以避免再次执行认证流程。
|
||||
|
||||
以下命令将此操作模式添加到路由：
|
||||
|
||||
|
||||
@ -163,7 +163,7 @@ plugin_attr:
|
||||
| consumer | 与请求匹配的 consumer 的 `consumer_name`。未匹配，则默认为空字符串。 |
|
||||
| node | 命中的 upstream 节点 `ip`。|
|
||||
|
||||
* `Bandwidth`: 流经 APISIX 的总带宽(可分出口带宽和入口带宽)，可以统计到每个服务的带宽总和。具有的维度：
|
||||
* `Bandwidth`: 流经 APISIX 的总带宽（可分出口带宽和入口带宽），可以统计到每个服务的带宽总和。具有的维度：
|
||||
|
||||
| 名称 | 描述 |
|
||||
| -------------| ------------- |
|
||||
@ -180,7 +180,7 @@ plugin_attr:
|
||||
|
||||
| 名称 | 描述 |
|
||||
| -------------| ------------- |
|
||||
| type | 该值可以为`apisix`, `upstream` 和 `request`，分别表示耗时的来源为 APISIX、上游及其总和。 |
|
||||
| type | 该值可以为 `apisix`、`upstream` 和 `request`，分别表示耗时的来源为 APISIX、上游及其总和。 |
|
||||
| service | 与请求匹配的 route 的 `service_id`。当路由缺少 service_id 时，则默认为 `$host`。 |
|
||||
| consumer | 与请求匹配的 consumer 的 `consumer_name`。未匹配，则默认为空字符串。 |
|
||||
| node | 命中的 upstream 节点 `ip`。 |
|
||||
|
||||
@ -37,7 +37,7 @@ title: tcp-logger
|
||||
|
||||
该插件提供了将 Log Data 作为批处理推送到外部 TCP 服务器的功能。如果您没有收到日志数据，请放心一些时间，它会在我们的批处理处理器中的计时器功能到期后自动发送日志。
|
||||
|
||||
有关Apache APISIX中Batch-Processor的更多信息，请参考。
|
||||
有关 Apache APISIX 中 Batch-Processor 的更多信息，请参考：
|
||||
[Batch-Processor](../batch-processor.md)
|
||||
|
||||
## 属性列表
|
||||
|
||||
@ -357,7 +357,7 @@ Content-Type: text/html; charset=utf-8
|
||||
world 1981
|
||||
```
|
||||
|
||||
match 规则校验失败，，命中默认端口为`1980`的 upstream。
|
||||
match 规则校验失败，命中默认端口为 `1980` 的 upstream。
|
||||
|
||||
```shell
|
||||
$ curl 'http://127.0.0.1:9080/index.html?name=jack' -H 'user-id:30' -H 'apisix-key: hello' -i
|
||||
|
||||
@ -38,7 +38,7 @@ title: udp-logger
|
||||
|
||||
此插件提供了将批处理数据批量推送到外部 UDP 服务器的功能。如果您没有收到日志数据，请放心一些时间，它会在我们的批处理处理器中的计时器功能到期后自动发送日志
|
||||
|
||||
有关 Apache APISIX 中 Batch-Processor 的更多信息，请参考。
|
||||
有关 Apache APISIX 中 Batch-Processor 的更多信息，请参考：
|
||||
[Batch-Processor](../batch-processor.md)
|
||||
|
||||
## 属性列表
|
||||
|
||||
@ -68,7 +68,7 @@ curl http://127.0.0.1:9080/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f03
|
||||
```
|
||||
|
||||
例子中 APISIX 对客户端 IP 为 `127.0.0.1` 的请求代理转发到上游主机 `127.0.0.1:1995`。
|
||||
更多用例，请参照 [test case](../../../t/stream-node/sanity.t).
|
||||
更多用例，请参照 [test case](../../../t/stream-node/sanity.t)。
|
||||
|
||||
## 更多 route 匹配选项
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user