doc: Chinese version of plugins request-id (#2103)

fix #2027
This commit is contained in:
Shuyang Wu 2020-08-23 11:17:18 +08:00 committed by GitHub
parent d974c1871a
commit 6ffd8b9956
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 93 additions and 4 deletions

View File

@ -17,7 +17,7 @@
#
-->
[Chinese](../zh-cn/plugins/request-validation.md)
[Chinese](../zh-cn/plugins/request-id.md)
# Summary
- [**Name**](#name)
@ -71,7 +71,7 @@ HTTP/1.1 200 OK
## Disable Plugin
Remove the corresponding json configuration in the plugin configuration to disable the `request-validation`.
Remove the corresponding json configuration in the plugin configuration to disable the `request-id`.
APISIX plugins are hot-reloaded, therefore no need to restart APISIX.
```shell

View File

@ -0,0 +1,89 @@
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-->
[English](../plugins/request-id.md)
# 目录
- [**名称**](#名称)
- [**属性**](#属性)
- [**如何启用**](#如何启用)
- [**测试插件**](#测试插件)
- [**禁用插件**](#禁用插件)
- [**示例**](#示例)
## 名称
`request-id` 插件通过 APISIX 为每一个请求代理添加唯一 IDUUID以用于追踪 API 请求。该插件在 `header_name` 已经在请求中存在时不会为请求添加新的 ID
## 属性
| 名称 | 必选项 | 描述 |
| ------------------- | ------ | ------------------------------------------- |
| header_name | 可选 | Request ID header name (默认: X-Request-Id) |
| include_in_response | 可选 | 是否需要在返回头中包含该唯一ID (默认: true) |
## 如何启用
创建一条路由并在该路由上启用 `request-id` 插件:
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/get",
"plugins": {
"request-id": {
"include_in_response": true
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:8080": 1
}
}
}
```
## 测试插件
```shell
$ curl -i http://127.0.0.1:9080/hello
HTTP/1.1 200 OK
```
## 禁用插件
在路由 `plugins` 配置块中删除 `request-id 配置,即可禁用该插件,无需重启 APISIX。
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/get",
"plugins": {
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:8080": 1
}
}
}
```

View File

@ -20,14 +20,14 @@
- [English](../../plugins/request-validation.md)
# 目录
- [**名字**](#名字)
- [**名称**](#名称)
- [**属性**](#属性)
- [**如何启用**](#如何启用)
- [**测试插件**](#测试插件)
- [**禁用插件**](#禁用插件)
- [**示例**](#示例)
## 名
## 名
`request-validation` 插件用于提前验证请求向上游转发请求,可以验证请求的 `body``header` 数据。