diff --git a/doc/admin-api-cn.md b/doc/admin-api-cn.md index 40303f42e51e..d2517d35a7a9 100644 --- a/doc/admin-api-cn.md +++ b/doc/admin-api-cn.md @@ -214,7 +214,7 @@ serivce 对象 json 配置内容: ```shell # 创建一个Service -$ curl http://127.0.0.1:9080/apisix/admin/services/201 -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' { "plugins": { "limit-count": { @@ -294,7 +294,7 @@ consumer 对象 json 配置内容: ```shell # 创建 Consumer ,指定认证插件 key-auth ,并开启特定插件 limit-count -$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' { "username": "jack", "plugins": { @@ -387,7 +387,7 @@ upstream 对象 json 配置内容: ```shell # 创建一个upstream -$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -i -X PUT -d ' +$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d ' > { > "type": "roundrobin", > "nodes": { diff --git a/doc/admin-api.md b/doc/admin-api.md index 4d1cc9ba708d..fae8e261bb21 100644 --- a/doc/admin-api.md +++ b/doc/admin-api.md @@ -209,7 +209,7 @@ Config Example: Example: ```shell -$ curl http://127.0.0.1:9080/apisix/admin/services/201 -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' { "plugins": { "limit-count": { @@ -286,7 +286,7 @@ The binding authentication and authorization plug-in is a bit special. When it n Example: ```shell -$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' { "username": "jack", "plugins": { @@ -378,7 +378,7 @@ Config Example: Example: ```shell -$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -i -X PUT -d ' +$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d ' > { > "type": "roundrobin", > "nodes": { diff --git a/doc/architecture-design-cn.md b/doc/architecture-design-cn.md index 96c6f539519d..b94fa1ebc619 100644 --- a/doc/architecture-design-cn.md +++ b/doc/architecture-design-cn.md @@ -559,6 +559,7 @@ HTTP/1.1 503 Service Temporarily Unavailable curl -X PUT \ https://{apisix_listen_address}/apisix/admin/global_rules/1 \ -H 'Content-Type: application/json' \ + -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \ -d '{ "plugins": { "limit-count": { @@ -577,7 +578,7 @@ curl -X PUT \ 我们可以通过以下接口查看所有的 `GlobalRule`: ```shell -curl https://{apisix_listen_address}/apisix/admin/global_rules +curl https://{apisix_listen_address}/apisix/admin/global_rules -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' ``` [返回目录](#目录) diff --git a/doc/architecture-design.md b/doc/architecture-design.md index 40ad09e19dcd..f2406af616ae 100644 --- a/doc/architecture-design.md +++ b/doc/architecture-design.md @@ -548,6 +548,7 @@ We can register a global [Plugin](#Plugin) with `GlobalRule`: curl -X PUT \ https://{apisix_listen_address}/apisix/admin/global_rules/1 \ -H 'Content-Type: application/json' \ + -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \ -d '{ "plugins": { "limit-count": { diff --git a/doc/plugins/http-logger-cn.md b/doc/plugins/http-logger-cn.md index 2cca9a35c035..b84e576d3c14 100644 --- a/doc/plugins/http-logger-cn.md +++ b/doc/plugins/http-logger-cn.md @@ -82,7 +82,7 @@ hello, world 在插件配置中删除相应的json配置以禁用http-logger。APISIX插件是热重载的,因此无需重新启动APISIX: ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/http-logger.md b/doc/plugins/http-logger.md index 55d0bc4eb9e7..b72325dfbe6b 100644 --- a/doc/plugins/http-logger.md +++ b/doc/plugins/http-logger.md @@ -85,7 +85,7 @@ Remove the corresponding json configuration in the plugin configuration to disab APISIX plugins are hot-reloaded, therefore no need to restart APISIX. ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/ip-restriction-cn.md b/doc/plugins/ip-restriction-cn.md index c9f1fcfdb5cf..87585740a1eb 100644 --- a/doc/plugins/ip-restriction-cn.md +++ b/doc/plugins/ip-restriction-cn.md @@ -86,7 +86,7 @@ HTTP/1.1 403 Forbidden 当你想去掉 `ip-restriction` 插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效: ```shell -$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "uri": "/index.html", "plugins": {}, diff --git a/doc/plugins/ip-restriction.md b/doc/plugins/ip-restriction.md index ddec4744e1d0..92c735f24d89 100644 --- a/doc/plugins/ip-restriction.md +++ b/doc/plugins/ip-restriction.md @@ -141,7 +141,7 @@ 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:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "uri": "/index.html", "plugins": {}, diff --git a/doc/plugins/kafka-logger-cn.md b/doc/plugins/kafka-logger-cn.md index c7c074519d7c..74b4196f2062 100644 --- a/doc/plugins/kafka-logger-cn.md +++ b/doc/plugins/kafka-logger-cn.md @@ -112,7 +112,7 @@ hello, world 当您要禁用`kafka-logger`插件时,这很简单,您可以在插件配置中删除相应的json配置,无需重新启动服务,它将立即生效: ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/kafka-logger.md b/doc/plugins/kafka-logger.md index 1bbd83c2ee94..809ea5203180 100644 --- a/doc/plugins/kafka-logger.md +++ b/doc/plugins/kafka-logger.md @@ -119,7 +119,7 @@ Remove the corresponding json configuration in the plugin configuration to disab APISIX plugins are hot-reloaded, therefore no need to restart APISIX. ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/proxy-cache-cn.md b/doc/plugins/proxy-cache-cn.md index 95f3bdaf7d0f..3a1337443581 100644 --- a/doc/plugins/proxy-cache-cn.md +++ b/doc/plugins/proxy-cache-cn.md @@ -48,7 +48,7 @@ 示例1:为特定路由启用 `proxy-cache` 插件: ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "proxy-cache": { @@ -130,7 +130,7 @@ Server: APISIX web server 移除插件配置中相应的 JSON 配置可立即禁用该插件,无需重启服务: ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-cache.md b/doc/plugins/proxy-cache.md index c8e668c81077..618995ebbff8 100644 --- a/doc/plugins/proxy-cache.md +++ b/doc/plugins/proxy-cache.md @@ -50,7 +50,7 @@ Note: 1: enable the proxy-cache plugin for a specific route : ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "proxy-cache": { @@ -130,7 +130,7 @@ Remove the corresponding JSON in the plugin configuration to disable the plugin ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-mirror-cn.md b/doc/plugins/proxy-mirror-cn.md index 4b3f0730cc21..2d310d0b1396 100644 --- a/doc/plugins/proxy-mirror-cn.md +++ b/doc/plugins/proxy-mirror-cn.md @@ -38,7 +38,7 @@ 示例1:为特定路由启用 `proxy-mirror` 插件: ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "proxy-mirror": { @@ -77,7 +77,7 @@ hello world 移除插件配置中相应的 JSON 配置可立即禁用该插件,无需重启服务: ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-mirror.md b/doc/plugins/proxy-mirror.md index 3b6ee542a344..7f5655451af3 100644 --- a/doc/plugins/proxy-mirror.md +++ b/doc/plugins/proxy-mirror.md @@ -39,7 +39,7 @@ The proxy-mirror plugin, which provides the ability to mirror client requests. 1: enable the proxy-mirror plugin for a specific route : ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "plugins": { "proxy-mirror": { @@ -81,7 +81,7 @@ Remove the corresponding JSON in the plugin configuration to disable the plugin ```shell -curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/skywalking-cn.md b/doc/plugins/skywalking-cn.md index a74dc84410c7..f0f09c82dbb8 100644 --- a/doc/plugins/skywalking-cn.md +++ b/doc/plugins/skywalking-cn.md @@ -132,7 +132,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1 当你想去掉插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效: ```shell -$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uris": [ diff --git a/doc/plugins/skywalking.md b/doc/plugins/skywalking.md index 4a3c7a4078fd..63f0228fe355 100644 --- a/doc/plugins/skywalking.md +++ b/doc/plugins/skywalking.md @@ -127,7 +127,7 @@ When you want to disable the skyWalking plugin, it is very simple, no need to restart the service, it will take effect immediately: ```shell -$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uris": [ diff --git a/doc/plugins/syslog-cn.md b/doc/plugins/syslog-cn.md index 0dfbf7282c3a..486d1606424c 100644 --- a/doc/plugins/syslog-cn.md +++ b/doc/plugins/syslog-cn.md @@ -90,7 +90,7 @@ hello, world 想要禁用“sys-logger”插件,是非常简单的,将对应的插件配置从json配置删除,就会立即生效,不需要重新启动服务: ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/syslog.md b/doc/plugins/syslog.md index 2d4307e758ac..41a971379800 100644 --- a/doc/plugins/syslog.md +++ b/doc/plugins/syslog.md @@ -90,7 +90,7 @@ Remove the corresponding json configuration in the plugin configuration to disab APISIX plugins are hot-reloaded, therefore no need to restart APISIX. ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/tcp-logger-cn.md b/doc/plugins/tcp-logger-cn.md index e5fa7c4a5b27..ba29772858ec 100644 --- a/doc/plugins/tcp-logger-cn.md +++ b/doc/plugins/tcp-logger-cn.md @@ -86,7 +86,7 @@ hello, world 想要禁用“tcp-logger”插件,是非常简单的,将对应的插件配置从json配置删除,就会立即生效,不需要重新启动服务: ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/tcp-logger.md b/doc/plugins/tcp-logger.md index 9fd47305fa84..1a6d4433bc4c 100644 --- a/doc/plugins/tcp-logger.md +++ b/doc/plugins/tcp-logger.md @@ -95,7 +95,7 @@ Remove the corresponding json configuration in the plugin configuration to disab APISIX plugins are hot-reloaded, therefore no need to restart APISIX. ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/udp-logger-cn.md b/doc/plugins/udp-logger-cn.md index bad70ddadede..9bdbc4f7d385 100644 --- a/doc/plugins/udp-logger-cn.md +++ b/doc/plugins/udp-logger-cn.md @@ -84,7 +84,7 @@ hello, world 想要禁用“udp-logger”插件,是非常简单的,将对应的插件配置从json配置删除,就会立即生效,不需要重新启动服务: ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/udp-logger.md b/doc/plugins/udp-logger.md index ad16550c5183..2d6d0f098698 100644 --- a/doc/plugins/udp-logger.md +++ b/doc/plugins/udp-logger.md @@ -90,7 +90,7 @@ Remove the corresponding json configuration in the plugin configuration to disab APISIX plugins are hot-reloaded, therefore no need to restart APISIX. ```shell -$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/zipkin-cn.md b/doc/plugins/zipkin-cn.md index ad53dc2aa569..857f798b903d 100644 --- a/doc/plugins/zipkin-cn.md +++ b/doc/plugins/zipkin-cn.md @@ -106,7 +106,7 @@ http://127.0.0.1:9411/zipkin 当你想去掉插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效: ```shell -$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/index.html", diff --git a/doc/plugins/zipkin.md b/doc/plugins/zipkin.md index b4bf4c0380b6..217f3c6fb060 100644 --- a/doc/plugins/zipkin.md +++ b/doc/plugins/zipkin.md @@ -111,7 +111,7 @@ When you want to disable the zipkin plugin, it is very simple, no need to restart the service, it will take effect immediately: ```shell -$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' { "methods": ["GET"], "uri": "/index.html",