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/08/06 06:14:07 UTC
[GitHub] [apisix] lunarwhite opened a new pull request, #7619: docs: refactor proxy-control
lunarwhite opened a new pull request, #7619:
URL: https://github.com/apache/apisix/pull/7619
### Description
update document under `docs/zh/latest/plugins/`
### Checklist
- [x] I have explained the need for this PR and the problem it solves
- [x] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [x] I have updated the documentation to reflect this change
- [x] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
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
[GitHub] [apisix] juzhiyuan merged pull request #7619: docs: refactor proxy-control
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #7619:
URL: https://github.com/apache/apisix/pull/7619
--
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
[GitHub] [apisix] hf400159 commented on a diff in pull request #7619: docs: refactor proxy-control
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7619:
URL: https://github.com/apache/apisix/pull/7619#discussion_r939749903
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -23,19 +28,23 @@ title: proxy-control
## 描述
-`proxy-control` 能够动态地控制 Nginx 代理的行为。
+`proxy-control` 插件能够动态地控制 Nginx 代理的行为。
Review Comment:
```suggestion
`proxy-control` 插件能够动态地控制 NGINX 代理的行为。
```
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -1,5 +1,10 @@
---
title: proxy-control
+keywords:
+ - APISIX
+ - API 网关
+ - Proxy Control
+description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作，你可以使用此插件动态地控制 Nginx 代理的行为。
Review Comment:
```suggestion
description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作，你可以使用此插件动态地控制 NGINX 代理的行为。
```
--
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
[GitHub] [apisix] SylviaBABY commented on a diff in pull request #7619: docs: refactor proxy-control
Posted by GitBox <gi...@apache.org>.
SylviaBABY commented on code in PR #7619:
URL: https://github.com/apache/apisix/pull/7619#discussion_r939764190
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -23,19 +28,23 @@ title: proxy-control
## 描述
-`proxy-control` 能够动态地控制 Nginx 代理的行为。
+`proxy-control` 插件能够动态地控制 Nginx 代理的行为。
Review Comment:
```suggestion
使用 `proxy-control` 插件能够动态地控制 NGINX 代理的相关行为。
```
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -1,5 +1,10 @@
---
title: proxy-control
+keywords:
+ - APISIX
+ - API 网关
+ - Proxy Control
+description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作，你可以使用此插件动态地控制 Nginx 代理的行为。
Review Comment:
```suggestion
description: 本文介绍了 Apache APISIX proxy-control 插件的相关操作，你可以使用此插件动态地控制 NGINX 代理的行为。
```
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -57,17 +66,17 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f03433
## 测试插件
-使用 `curl` 去测试：
+启用插件后，使用 `curl` 命令请求该路由来上传一个大文件：
Review Comment:
```suggestion
启用插件后，使用 `curl` 命令请求该路由进行一个大文件的上传测试：
```
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -57,17 +66,17 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f03433
## 测试插件
-使用 `curl` 去测试：
+启用插件后，使用 `curl` 命令请求该路由来上传一个大文件：
```shell
curl -i http://127.0.0.1:9080/upload -d @very_big_file
```
-将不会在 error 日志中找到 "a client request body is buffered to a temporary file" 。
+如果在错误日志中没有找到关于 "a client request body is buffered to a temporary file" 的信息，则说明插件生效。
## 禁用插件
-当您要禁用这个插件时，这很简单，您可以在插件配置中删除相应的 json 配置，无需重新启动服务，它将立即生效：
+当你需要禁用该插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review Comment:
```suggestion
curl http://127.0.0.1:9080/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
```
##########
docs/en/latest/plugins/proxy-control.md:
##########
@@ -2,10 +2,9 @@
title: proxy-control
keywords:
- APISIX
- - Plugin
+ - API Gateway
- Proxy Control
- - proxy-control
-description: This document contains information about the Apache APISIX proxy-control Plugin.
+description: This document contains information about the Apache APISIX proxy-control Plugin, you can use it to control the behavior of the Nginx proxy dynamically.
Review Comment:
```suggestion
description: This document contains information about the Apache APISIX proxy-control Plugin, you can use it to control the behavior of the NGINX proxy dynamically.
```
##########
docs/zh/latest/plugins/proxy-control.md:
##########
@@ -23,19 +28,23 @@ title: proxy-control
## 描述
-`proxy-control` 能够动态地控制 Nginx 代理的行为。
+`proxy-control` 插件能够动态地控制 Nginx 代理的行为。
-**这个插件需要 APISIX 在 [APISIX-Base](../FAQ.md#如何构建-apisix-base-环境) 上运行。**
+:::info 重要
+
+此插件需要 APISIX 在 [APISIX-Base](../FAQ.md#如何构建-apisix-base-环境) 环境上运行。更多信息请参考 [apisix-build-tools](https://github.com/api7/apisix-build-tools)。
+
+:::
## 属性
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
| --------- | ------------- | ----------- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| request_buffering | boolean | 可选 | true | | 动态设置 [`proxy_request_buffering`](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering) |
+| request_buffering | boolean | 否 | true | | 如果设置为 `true`，插件将动态设置 [`proxy_request_buffering`](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_request_buffering)。 |
-## 如何启用
+## 启用插件
-以下是一个示例，在指定路由中启用插件：
+以下示例展示了如何在指定路由上启用 `proxy-control` 插件：
```shell
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review Comment:
```suggestion
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
```
--
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