You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by me...@apache.org on 2019/11/24 13:15:47 UTC
[incubator-apisix] branch master updated: doc: fixed some typo and
update content. (#895)
This is an automated email from the ASF dual-hosted git repository.
membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 24d1190 doc: fixed some typo and update content. (#895)
24d1190 is described below
commit 24d1190e83007a6a8e7f4db1f48b423b7df8681b
Author: agile6v <ag...@agile6v.com>
AuthorDate: Sun Nov 24 21:15:39 2019 +0800
doc: fixed some typo and update content. (#895)
---
README.md | 2 +-
doc/README.md | 8 +++---
doc/benchmark.md | 2 +-
doc/https.md | 2 +-
doc/plugins.md | 2 +-
doc/plugins/grpc-transcoding.md | 23 +++++++++--------
doc/plugins/ip-restriction.md | 12 ++++-----
doc/plugins/jwt-auth.md | 14 +++++-----
doc/plugins/key-auth.md | 7 +++--
doc/plugins/limit-conn.md | 35 ++++++++++++++-----------
doc/plugins/limit-count.md | 27 +++++++++++--------
doc/plugins/limit-req.md | 31 ++++++++++++++--------
doc/plugins/prometheus.md | 2 +-
doc/plugins/proxy-rewrite.md | 33 ++++++++++++++----------
doc/plugins/redirect.md | 25 ++++++++++--------
doc/plugins/response-rewrite.md | 57 ++++++++++++++++++++++++++++++-----------
doc/plugins/serverless.md | 35 +++++++++++++++++--------
doc/plugins/zipkin.md | 9 ++++---
doc/stand-alone.md | 2 +-
doc/stream-proxy.md | 2 +-
20 files changed, 204 insertions(+), 126 deletions(-)
diff --git a/README.md b/README.md
index 5f2d94c..883f841 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
#
-->
-[中文](README_CN.md)
+[Chinese](README_CN.md)
## APISIX
[](https://travis-ci.org/apache/incubator-apisix)
diff --git a/doc/README.md b/doc/README.md
index 7198173..8e6c728 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -16,9 +16,9 @@
# limitations under the License.
#
-->
-[中文](README_CN.md)
+[Chinese](README_CN.md)
-Reference document
+Reference Documentation
==================
* [APISIX Readme](../README.md)
@@ -41,7 +41,7 @@ Plugins
* [hot reload](plugins.md): Hot reload without reload service.
* [key-auth](plugins/key-auth.md): User authentication based on Key Authentication.
-* [JWT-auth](plugins/jwt-auth-cn.md): User authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
+* [JWT-auth](plugins/jwt-auth.md): User authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
* [HTTPS/TLS](https.md): Dynamic load the SSL Certificate by Server Name Indication (SNI).
* [limit-count](plugins/limit-count.md): Rate limiting based on a "fixed window" implementation.
* [limit-req](plugins/limit-req.md): Request rate limiting and adjustment based on the "leaky bucket" method.
@@ -50,7 +50,7 @@ Plugins
* [prometheus](plugins/prometheus.md): Expose metrics related to APISIX and proxied upstream services in Prometheus exposition format, which can be scraped by a Prometheus Server.
* [OpenTracing](plugins/zipkin.md): Supports Zikpin and Apache SkyWalking.
* [grpc-transcode](plugins/grpc-transcoding.md): REST <--> gRPC transcoding。
-* [serverless](plugins/serverless-cn.md)：AllowS to dynamically run Lua code at *different* phase in APISIX.
+* [serverless](plugins/serverless.md)：Allows to dynamically run Lua code at *different* phase in APISIX.
* [ip-restriction](plugins/ip-restriction.md): IP whitelist/blacklist.
* openid-connect
* [redirect](plugins/redirect.md): URI redirect.
diff --git a/doc/benchmark.md b/doc/benchmark.md
index 9a70ba5..b2fbf11 100644
--- a/doc/benchmark.md
+++ b/doc/benchmark.md
@@ -17,7 +17,7 @@
#
-->
-[中文](benchmark-cn.md)
+[Chinese](benchmark-cn.md)
### Benchmark Environments
n1-highcpu-8 (8 vCPUs, 7.2 GB memory) on Google Cloud
diff --git a/doc/https.md b/doc/https.md
index 6405859..c63c709 100644
--- a/doc/https.md
+++ b/doc/https.md
@@ -17,7 +17,7 @@
#
-->
-[中文](https-cn.md)
+[Chinese](https-cn.md)
### HTTPS
`APISIX` supports to load a specific SSL certificate by TLS extension Server Name Indication (SNI).
diff --git a/doc/plugins.md b/doc/plugins.md
index f41e39d..711290c 100644
--- a/doc/plugins.md
+++ b/doc/plugins.md
@@ -17,7 +17,7 @@
#
-->
-[中文](plugins-cn.md)
+[Chinese](plugins-cn.md)
## Hot reload
APISIX plug-ins are hot-loaded. No matter you add, delete or modify plug-ins, you don't need to restart the service.
diff --git a/doc/plugins/grpc-transcoding.md b/doc/plugins/grpc-transcoding.md
index 23be79c..0b5c391 100644
--- a/doc/plugins/grpc-transcoding.md
+++ b/doc/plugins/grpc-transcoding.md
@@ -17,14 +17,15 @@
#
-->
-[中文](grpc-transcoding-cn.md)
-# grpc-transcoding
+[Chinese](grpc-transcoding-cn.md)
+
+## Name
HTTP(s) -> APISIX -> gRPC server
### Proto
-#### Parameters
+#### Attributes
* `content`: `.proto` file's content.
#### Add a proto
@@ -48,15 +49,15 @@ curl http://127.0.0.1:9080/apisix/admin/proto/1 -X PUT -d '
}'
```
-### Parameters
-
-* `proto_id`: `.proto` content id.
-* `service`: the grpc service name.
-* `method`: the method name of grpc service.
+## Attributes
-### example
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+| proto_id |required|`.proto` content id.|
+| service |required|the grpc service name.|
+| method |required|the method name of grpc service.|
-#### enable plugin
+## How To Enable
Here's an example, to enable the grpc-transcode plugin to specified route:
@@ -86,7 +87,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/111 -X PUT -d '
```
-#### test plugin
+## Test Plugin
The above configuration proxy :
```shell
diff --git a/doc/plugins/ip-restriction.md b/doc/plugins/ip-restriction.md
index cc840a2..429003f 100644
--- a/doc/plugins/ip-restriction.md
+++ b/doc/plugins/ip-restriction.md
@@ -17,7 +17,7 @@
#
-->
-[中文](ip-restriction-cn.md)
+[Chinese](ip-restriction-cn.md)
# Summary
- [**Name**](#name)
@@ -35,19 +35,17 @@ in CIDR notation like 10.10.10.0/24 can be used(will support IPv6 soon).
## Attributes
-|name |option |description|
+|Name |Requirement |Description|
|---------|--------|-----------|
-|whitelist|option |List of IPs or CIDR ranges to whitelist|
-|blacklist|option |List of IPs or CIDR ranges to blacklist|
+|whitelist|optional |List of IPs or CIDR ranges to whitelist|
+|blacklist|optional |List of IPs or CIDR ranges to blacklist|
One of `whitelist` or `blacklist` must be specified, and they can not work
together.
## How To Enable
-Two steps are required:
-
-1. creates a route or service object, and enable plugin `ip-restriction`.
+Creates a route or service object, and enable plugin `ip-restriction`.
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
diff --git a/doc/plugins/jwt-auth.md b/doc/plugins/jwt-auth.md
index f4883bd..5a5aa06 100644
--- a/doc/plugins/jwt-auth.md
+++ b/doc/plugins/jwt-auth.md
@@ -17,7 +17,7 @@
#
-->
-[中文](jwt-auth-cn.md)
+[Chinese](jwt-auth-cn.md)
# Summary
- [**Name**](#name)
@@ -37,10 +37,12 @@ For more information on JWT, refer to [JWT](https://jwt.io/) for more informatio
## Attributes
-* `key`: different `consumer` have different value, it's unique. different `consumer` use the same `key`, and there will be a request matching exception.
-* `secret`: optional, encryption key. if you do not specify, the value is auto-generated in the background.
-* `algorithm`: optional, encryption algorithm .support`HS256`, `HS384`, `HS512`, `RS256` and `ES256`,`HS256` is default.
-* `exp`: optional, token's expire time, the unit is second. for example, 5 minutes, need to set the value of 300.( 5 * 60 = 300 ).
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+| key |required|different `consumer` have different value, it's unique. different `consumer` use the same `key`, and there will be a request matching exception.|
+| secret |optional|encryption key. if you do not specify, the value is auto-generated in the background.|
+| algorithm | optional|encryption algorithm. support`HS256`, `HS384`, `HS512`, `RS256` and `ES256`,`HS256` is default.|
+| exp |optional|token's expire time, the unit is second. for example, 5 minutes, need to set the value of 300.( 5 * 60 = 300 )|
## How To Enable
@@ -157,7 +159,7 @@ Accept-Ranges: bytes
...
```
-## *Disable Plugin
+## Disable Plugin
When you want to disable the `jwt-auth` plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
diff --git a/doc/plugins/key-auth.md b/doc/plugins/key-auth.md
index 08cd625..743b9ea 100644
--- a/doc/plugins/key-auth.md
+++ b/doc/plugins/key-auth.md
@@ -17,7 +17,7 @@
#
-->
-[中文](key-auth-cn.md)
+[Chinese](key-auth-cn.md)
# Summary
- [**Name**](#name)
@@ -35,7 +35,10 @@ Add Key Authentication (also sometimes referred to as an API key) to a Service o
## Attributes
-* `key`: different consumer objects should use different values, it should be unique.
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+| key |required|different consumer objects should use different values, it should be unique.|
+
## How To Enable
diff --git a/doc/plugins/limit-conn.md b/doc/plugins/limit-conn.md
index ee02f90..c73ebac 100644
--- a/doc/plugins/limit-conn.md
+++ b/doc/plugins/limit-conn.md
@@ -17,25 +17,30 @@
#
-->
-[中文](limit-conn-cn.md)
-# limit-conn
+[Chinese](limit-conn-cn.md)
-Limiting request concurrency (or concurrent connections) plugin for Apisix.
-
-### Parameters
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
-* `conn`: is the maximum number of concurrent requests allowed. Requests exceeding this ratio (and below `conn` + `burst`) will get delayed to conform to this threshold.
-* `burst`: is the number of excessive concurrent requests (or connections) allowed to be delayed.
-* `default_conn_delay`: is the default processing latency of a typical connection (or request).
-* `key`: is the user specified key to limit the concurrency level.
+## Name
- For example, one can use the host name (or server zone) as the key so that we limit concurrency per host name. Otherwise, we can also use the client address as the key so that we can avoid a single client from flooding our service with too many parallel connections or requests.
+Limiting request concurrency (or concurrent connections) plugin for Apisix.
- Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header.
+## Attributes
-* `rejected_code`: The HTTP status code returned when the request exceeds the threshold is rejected. The default is 503.
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+|conn |required|is the maximum number of concurrent requests allowed. Requests exceeding this ratio (and below `conn` + `burst`) will get delayed to conform to this threshold.|
+|burst |required|is the number of excessive concurrent requests (or connections) allowed to be delayed.|
+|default_conn_delay |required|is the default processing latency of a typical connection (or request).|
+|key |required|is the user specified key to limit the concurrency level. <br>For example, one can use the host name (or server zone) as the key so that we limit concurrency per host name. Otherwise, we can also use the client address as the key so that we can avoid a single client from flooding our service with too many parallel connections or requests. <br> Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header.|
+|rejected_code |required| The HTTP status code returned when the request exceeds the threshold is rejected. The default is 503.|
-#### enable plugin
+## How To Enable
Here's an example, enable the limit-conn plugin on the specified route:
@@ -68,7 +73,7 @@ You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`
Then add limit-conn plugin:
-#### test plugin
+## Test Plugin
The parameters of the plugin enabled above indicate that only one concurrent request is allowed. When more than one concurrent request is received, will return `503` directly.
@@ -87,7 +92,7 @@ curl -i http://127.0.0.1:9080/index.html?sleep=20
This means that the limit request concurrency plugin is in effect.
-#### disable plugin
+## Disable Plugin
When you want to disable the limit-conn plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
diff --git a/doc/plugins/limit-count.md b/doc/plugins/limit-count.md
index 9b22bda..49ffeb6 100644
--- a/doc/plugins/limit-count.md
+++ b/doc/plugins/limit-count.md
@@ -17,12 +17,22 @@
#
-->
-[中文](limit-count-cn.md)
-# limit-count
+[Chinese](limit-count-cn.md)
-### Parameters
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
-|name |option |description|
+## Name
+
+Limit request rate by a fixed number of requests in a given time window.
+
+## Attributes
+
+|Name |Requirement |Description|
|--------- |--------|-----------|
|count |required|the specified number of requests threshold.|
|time_window |required|the time window in seconds before the request count is reset.|
@@ -33,10 +43,7 @@
|redis_port |optional|When using the `redis` policy, this property specifies the port of the Redis server. The default port is 6379.|
|redis_timeout |optional|When using the `redis` policy, this property specifies the timeout in milliseconds of any command submitted to the Redis server. The default timeout is 1000 ms(1 second).|
-
-### example
-
-#### enable plugin
+## How To Enable
Here's an example, enable the `limit count` plugin on the specified route:
@@ -96,7 +103,7 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
}'
```
-#### test plugin
+## Test Plugin
The above configuration limits access to only 2 times in 60 seconds. The first two visits will be normally:
```shell
curl -i http://127.0.0.1:9080/index.html
@@ -133,7 +140,7 @@ Server: APISIX web server
This means that the `limit count` plugin is in effect.
-#### disable plugin
+## Disable Plugin
When you want to disable the `limit count` plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
no need to restart the service, it will take effect immediately:
diff --git a/doc/plugins/limit-req.md b/doc/plugins/limit-req.md
index 349cd17..59c1847 100644
--- a/doc/plugins/limit-req.md
+++ b/doc/plugins/limit-req.md
@@ -17,20 +17,29 @@
#
-->
-[中文](limit-req-cn.md)
-# limit-req
+[Chinese](limit-req-cn.md)
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
limit request rate using the "leaky bucket" method.
-### Parameters
-* `rate`: is the specified request rate (number per second) threshold.Requests exceeding this rate (and below `burst`) will get delayed to conform to the rate.
-* `burst`: is the number of excessive requests per second allowed to be delayed. Requests exceeding this hard limit will get rejected immediately.
-* `rejected_code`: The HTTP status code returned when the request exceeds the threshold is rejected. The default is 503.
-* `key`: is the user specified key to limit the rate, now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header.
+## Attributes
+
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+|rate |required|is the specified request rate (number per second) threshold. Requests exceeding this rate (and below `burst`) will get delayed to conform to the rate.|
+|burst |required|is the number of excessive requests per second allowed to be delayed. Requests exceeding this hard limit will get rejected immediately.|
+|rejected_code |required|The HTTP status code returned when the request exceeds the threshold is rejected. The default is 503.|
+| key |required|is the user specified key to limit the rate, now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header.|
-### example
+## How To Enable
-#### enable plugin
Here's an example, enable the limit req plugin on the specified route:
```shell
@@ -63,7 +72,7 @@ Then add limit-req plugin:
-#### test plugin
+## Test Plugin
The above configuration limits the request rate to 1 per second. If it is greater than 1 and less than 3, the delay will be added. If the rate exceeds 3, it will be rejected:
```shell
curl -i http://127.0.0.1:9080/index.html
@@ -88,7 +97,7 @@ Server: APISIX web server
This means that the limit req plugin is in effect.
-#### disable plugin
+## Disable Plugin
When you want to disable the limit req plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
no need to restart the service, it will take effect immediately:
diff --git a/doc/plugins/prometheus.md b/doc/plugins/prometheus.md
index 7c2eadb..e40c63f 100644
--- a/doc/plugins/prometheus.md
+++ b/doc/plugins/prometheus.md
@@ -17,7 +17,7 @@
#
-->
-[中文](prometheus-cn.md)
+[Chinese](prometheus-cn.md)
# prometheus
This plugin exposes metrics in Prometheus Exposition format.
diff --git a/doc/plugins/proxy-rewrite.md b/doc/plugins/proxy-rewrite.md
index 845f9b8..ef480df 100644
--- a/doc/plugins/proxy-rewrite.md
+++ b/doc/plugins/proxy-rewrite.md
@@ -17,23 +17,30 @@
#
-->
-[中文](proxy-rewrite-cn.md)
-# proxy-rewrite
+[Chinese](proxy-rewrite-cn.md)
+
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
upstream proxy info rewrite plugin.
-### Parameters
-|Name |Required|Description|
+## Attributes
+|Name | Requirement |Description|
|------- |-----|------|
-|scheme |No| Upstream new `schema` forwarding protocol,options can be `http` or `https`,default `http`.|
-|uri |No| Upstream new `uri` forwarding address.|
-|host |No| Upstream new `host` forwarding address, example `iresty.com`. |
-|enable_websocket|No| enable `websocket`(boolean), default `false`.|
-|headers |No| Forward to the new `headers` of the upstream, can set up multiple. If it exists, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header.|
+|scheme |optional| Upstream new `schema` forwarding protocol,options can be `http` or `https`,default `http`.|
+|uri |optional| Upstream new `uri` forwarding address.|
+|host |optional| Upstream new `host` forwarding address, example `iresty.com`. |
+|enable_websocket|optional| enable `websocket`(boolean), default `false`.|
+|headers |optional| Forward to the new `headers` of the upstream, can set up multiple. If it exists, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header.|
-### Example
+## How To Enable
-#### Enable Plugin
Here's an example, enable the `proxy rewrite` plugin on the specified route:
```shell
@@ -63,7 +70,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
}'
```
-#### Test Plugin
+## Test Plugin
Testing based on the above examples :
```shell
curl -X GET http://127.0.0.1:9080/test/index.html
@@ -76,7 +83,7 @@ Send the request and see upstream `access.log', if the output information is con
This means that the `proxy rewrite` plugin is in effect.
-#### Disable Plugin
+## Disable Plugin
When you want to disable the `proxy rewrite` plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
no need to restart the service, it will take effect immediately :
diff --git a/doc/plugins/redirect.md b/doc/plugins/redirect.md
index d38aafa..8a0e44c 100644
--- a/doc/plugins/redirect.md
+++ b/doc/plugins/redirect.md
@@ -17,22 +17,27 @@
#
-->
-[中文](redirect-cn.md)
+[Chinese](redirect-cn.md)
-# redirect
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
URI redirect.
-### Parameters
+## Attributes
-|Name |Required|Description|
+|Name |Requirement|Description|
|------- |-----|------|
|uri |required| New uri which can contain Ningx variable, eg: `/test/index.html`, `$uri/index.html`. You can refer to variables in a way similar to `${xxx}` to avoid ambiguity, eg: `${uri}foo/index.html`. If you just need the original `$` character, add `\` in front of it, like this one: `/\$foo/index.html`. If you refer to a variable name that does not exist, this will not produce an error, and it will be used as an empty string.|
-|ret_code|option|Response code, the default value is `302`.|
-
-### Example
+|ret_code|optional|Response code, the default value is `302`.|
-#### Enable Plugin
+## How To Enable
Here's a mini example, enable the `redirect` plugin on the specified route:
@@ -76,7 +81,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
}'
```
-#### Test Plugin
+## Test Plugin
Testing based on the above examples :
@@ -96,7 +101,7 @@ We can check the response code and the response header `Location`.
It shows that the `redirect` plugin is in effect.
-#### Disable Plugin
+## Disable Plugin
When you want to disable the `redirect` plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
diff --git a/doc/plugins/response-rewrite.md b/doc/plugins/response-rewrite.md
index 5a034aa..eb0983d 100644
--- a/doc/plugins/response-rewrite.md
+++ b/doc/plugins/response-rewrite.md
@@ -17,25 +17,30 @@
#
-->
-[中文](response-rewrite-cn.md)
-# response-rewrite
+[Chinese](response-rewrite-cn.md)
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
response rewrite plugin, rewrite the content from upstream.
-senario:
-1、can set `Access-Control-Allow-*` series field to support CORS(Cross-origin Resource Sharing) .
-2、we can set customized `status_code` and `Location` field in header to achieve redirect, you can alse use [redirect](redirect-cn.md) plugin if you just want a redirect function.
+**senario**:
+1. can set `Access-Control-Allow-*` series field to support CORS(Cross-origin Resource Sharing).
+2. we can set customized `status_code` and `Location` field in header to achieve redirect, you can alse use [redirect](redirect-cn.md) plugin if you just want a redirect function.function
-### Parameters
-|Name |Required|Description|
+## Attributes
+|Name |Requirement|Description|
|------- |-----|------|
-|status_code |No| New `status code` to client|
-|body |No| New `body` to client, and the content-length will be reset too.|
-|headers |No| Set the new `headers` for client, can set up multiple. If it exists already from upstream, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header. |
-
-### Example
+|status_code |optional| New `status code` to client|
+|body |optional| New `body` to client, and the content-length will be reset too.|
+|headers |optional| Set the new `headers` for client, can set up multiple. If it exists already from upstream, will rewrite the header, otherwise will add the header. You can set the corresponding value to an empty string to remove a header. |
-#### Enable Plugin
+## How To Enable
Here's an example, enable the `response rewrite` plugin on the specified route:
```shell
@@ -61,13 +66,14 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
}'
```
-#### Test Plugin
+## Test Plugin
Testing based on the above examples :
+
```shell
curl -X GET -i http://127.0.0.1:9080/test/index.html
```
-It will output like below,no matter what kinf of content from upstream.
+It will output like below,no matter what kind of content from upstream.
```
HTTP/1.1 200 OK
Date: Sat, 16 Nov 2019 09:15:12 GMT
@@ -80,3 +86,24 @@ X-Server-status: on
```
This means that the `response rewrite` plugin is in effect.
+
+## Disable Plugin
+When you want to disable the `response rewrite` plugin, it is very simple,
+ you can delete the corresponding json configuration in the plugin configuration,
+ no need to restart the service, it will take effect immediately:
+```shell
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
+{
+ "methods": ["GET"],
+ "uri": "/test/index.html",
+ "upstream": {
+ "type": "roundrobin",
+ "nodes": {
+ "127.0.0.1:80": 1
+ }
+ }
+}'
+```
+
+The `response rewrite` plugin has been disabled now. It works for other plugins.
+
diff --git a/doc/plugins/serverless.md b/doc/plugins/serverless.md
index 4b7047f..ff193af 100644
--- a/doc/plugins/serverless.md
+++ b/doc/plugins/serverless.md
@@ -17,20 +17,32 @@
#
-->
-[中文](serverless-cn.md)
-# serverless
+[Chinese](serverless-cn.md)
+
+# Summary
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
+
There are two plug-ins for serverless, namely `serverless-pre-function` and `serverless-post-function`.
The former runs at the beginning of the specified phase, while the latter runs at the end of the specified phase.
Both plug-ins receive the same parameters.
-### Parameters
-* `phase`: The default phase is `access`, if not specified. The valid phases are: `rewrite`, `access`,`Header_filer`, `body_filter`, `log` and `balancer`.
+## Attributes
-* `functions`: A list of functions that are specified to run is an array type, which can contain either one function or multiple functions, executed sequentially.
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+| phase |optional|The default phase is `access`, if not specified. The valid phases are: `rewrite`, `access`,`Header_filer`, `body_filter`, `log` and `balancer`.|
+| functions |required|A list of functions that are specified to run is an array type, which can contain either one function or multiple functions, executed sequentially.|
-Note that only function is accepted here, not other types of Lua code. For example, anonymous functions are legal:
+
+Note that only function is accepted here, not other types of Lua code. For example, anonymous functions are legal:<br>
```
return function()
ngx.log(ngx.ERR, 'one')
@@ -46,15 +58,14 @@ return function()
end
```
- But code that is not a function type is illegal:
+But code that is not a function type is illegal:
```
local count = 1
ngx.say(count)
```
-### Example
+## How To Enable
-#### enable plugin
Here's an example, enable the serverless plugin on the specified route:
```shell
@@ -78,7 +89,8 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
}'
```
-#### test plugin
+## Test Plugin
+
Use curl to access:
```shell
curl -i http://127.0.0.1:9080/index.html
@@ -87,7 +99,8 @@ curl -i http://127.0.0.1:9080/index.html
Then you will find the message 'serverless pre-function' in the error.log,
which indicates that the specified function is in effect.
-#### disable plugin
+## Disable Plugin
+
When you want to disable the serverless plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
no need to restart the service, it will take effect immediately:
diff --git a/doc/plugins/zipkin.md b/doc/plugins/zipkin.md
index ef5cfa3..629e35b 100644
--- a/doc/plugins/zipkin.md
+++ b/doc/plugins/zipkin.md
@@ -17,7 +17,7 @@
#
-->
-[中文](zipkin-cn.md)
+[Chinese](zipkin-cn.md)
# Summary
- [**Name**](#name)
@@ -35,9 +35,10 @@ It's also works with `Apache SkyWalking`, which is support Zipkin v1/v2 format.
## Attributes
-* `endpoint`: the http endpoint of Ziplin, for example: `http://127.0.0.1:9411/api/v2/spans`.
-
-* `sample_ratio`: the ratio of sample, the minimum is 0.00001, the maximum is 1.
+|Name |Requirement |Description|
+|--------- |--------|-----------|
+| endpoint |required|the http endpoint of Ziplin, for example: `http://127.0.0.1:9411/api/v2/spans`.|
+| sample_ratio |required|the ratio of sample, the minimum is 0.00001, the maximum is 1.|
## How To Enable
diff --git a/doc/stand-alone.md b/doc/stand-alone.md
index a2d5dba..2093ae4 100644
--- a/doc/stand-alone.md
+++ b/doc/stand-alone.md
@@ -17,7 +17,7 @@
#
-->
-[中文](stand-alone-cn.md)
+[Chinese](stand-alone-cn.md)
## Stand-alone mode
diff --git a/doc/stream-proxy.md b/doc/stream-proxy.md
index 980098b..0bf1197 100644
--- a/doc/stream-proxy.md
+++ b/doc/stream-proxy.md
@@ -17,7 +17,7 @@
#
-->
-[中文](stream-proxy-cn.md)
+[Chinese](stream-proxy-cn.md)
# Stream Proxy