From 63d7250d515a82da3e303623b88cca69a5c49c92 Mon Sep 17 00:00:00 2001 From: Miss-you Date: Sat, 6 Jun 2020 02:03:23 +0800 Subject: [PATCH 1/3] yousali:Supplement `-H 'X-API-KEY for each interface that operates admin: edd1c9f034335f136f87ad84b625c8f1' ` parameter --- doc/admin-api-cn.md | 18 ++++++++++-------- doc/admin-api.md | 18 ++++++++++-------- doc/architecture-design-cn.md | 3 ++- doc/architecture-design.md | 1 + doc/plugins/http-logger-cn.md | 2 +- doc/plugins/http-logger.md | 13 +++++++------ doc/plugins/ip-restriction-cn.md | 2 +- doc/plugins/ip-restriction.md | 15 +++++++++------ doc/plugins/kafka-logger-cn.md | 2 +- doc/plugins/kafka-logger.md | 16 +++++++++------- doc/plugins/proxy-cache-cn.md | 4 ++-- doc/plugins/proxy-cache.md | 4 ++-- doc/plugins/proxy-mirror-cn.md | 4 ++-- doc/plugins/proxy-mirror.md | 4 ++-- doc/plugins/skywalking-cn.md | 2 +- doc/plugins/skywalking.md | 19 ++++++++++--------- doc/plugins/syslog-cn.md | 2 +- doc/plugins/syslog.md | 13 +++++++------ doc/plugins/tcp-logger-cn.md | 2 +- doc/plugins/tcp-logger.md | 13 +++++++------ doc/plugins/udp-logger-cn.md | 2 +- doc/plugins/udp-logger.md | 13 +++++++------ doc/plugins/zipkin-cn.md | 2 +- doc/plugins/zipkin.md | 15 +++++++++------ 24 files changed, 104 insertions(+), 85 deletions(-) diff --git a/doc/admin-api-cn.md b/doc/admin-api-cn.md index 40303f42e51e..fcc375b1574b 100644 --- a/doc/admin-api-cn.md +++ b/doc/admin-api-cn.md @@ -19,11 +19,13 @@ # 目录 -* [Route](#route) -* [Service](#service) -* [Consumer](#consumer) -* [Upstream](#upstream) -* [SSL](#ssl) +- [目录](#%e7%9b%ae%e5%bd%95) + - [Route](#route) + - [运算符列表](#%e8%bf%90%e7%ae%97%e7%ac%a6%e5%88%97%e8%a1%a8) + - [Service](#service) + - [Consumer](#consumer) + - [Upstream](#upstream) + - [SSL](#ssl) ## Route @@ -214,7 +216,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 +296,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 +389,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..d547a2068d05 100644 --- a/doc/admin-api.md +++ b/doc/admin-api.md @@ -21,11 +21,13 @@ === -* [Route](#route) -* [Service](#service) -* [Consumer](#consumer) -* [Upstream](#upstream) -* [SSL](#ssl) +- [Table of Contents](#table-of-contents) + - [Route](#route) + - [Available Operators](#available-operators) + - [Service](#service) + - [Consumer](#consumer) + - [Upstream](#upstream) + - [SSL](#ssl) ## Route @@ -209,7 +211,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 +288,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 +380,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..3e88b4ce2d68 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..acc58405813f 100644 --- a/doc/plugins/http-logger.md +++ b/doc/plugins/http-logger.md @@ -18,11 +18,12 @@ --> # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Disable Plugin](#disable-plugin) ## Name @@ -85,7 +86,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..4d407e6157d2 100644 --- a/doc/plugins/ip-restriction.md +++ b/doc/plugins/ip-restriction.md @@ -20,11 +20,14 @@ [Chinese](ip-restriction-cn.md) # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Change the restriction](#change-the-restriction) + - [Test Plugin after restriction change](#test-plugin-after-restriction-change) + - [Disable Plugin](#disable-plugin) ## Name @@ -141,7 +144,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..eaf5c35cf2e4 100644 --- a/doc/plugins/kafka-logger.md +++ b/doc/plugins/kafka-logger.md @@ -18,12 +18,14 @@ --> # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**Info**](#info) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [Info](#info) + - [Sample broker list](#sample-broker-list) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Disable Plugin](#disable-plugin) ## Name @@ -119,7 +121,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..8ca3830d87f0 100644 --- a/doc/plugins/skywalking.md +++ b/doc/plugins/skywalking.md @@ -20,14 +20,15 @@ [Chinese](skywalking-cn.md) # Summary -- [**Summary**](#Summary) - - [**Name**](#Name) - - [**Attributes**](#Attributes) - - [**How To Enable**](#How-To-Enable) - - [**Test Plugin**](#Test-Plugin) - - [**Run Skywalking Example**](#Run-Skywalking-Example) - - [**Disable Plugin**](#Disable-Plugin) - - [**Upstream services(Code With SpringBoot)**](#Upstream-services(Code-With-SpringBoot)) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Run-Skywalking-Example](#run-skywalking-example) + - [e.g.](#eg) + - [Disable Plugin](#disable-plugin) + - [Upstream services(Code With SpringBoot)](#upstream-servicescode-with-springboot) ## Name @@ -127,7 +128,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..ed93a0901afa 100644 --- a/doc/plugins/syslog.md +++ b/doc/plugins/syslog.md @@ -18,11 +18,12 @@ --> # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Disable Plugin](#disable-plugin) ## Name @@ -90,7 +91,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..a5baa0701c33 100644 --- a/doc/plugins/tcp-logger.md +++ b/doc/plugins/tcp-logger.md @@ -19,11 +19,12 @@ # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Disable Plugin](#disable-plugin) ## Name @@ -95,7 +96,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..d3e55f3b7cb3 100644 --- a/doc/plugins/udp-logger.md +++ b/doc/plugins/udp-logger.md @@ -19,11 +19,12 @@ # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [Disable Plugin](#disable-plugin) ## Name @@ -90,7 +91,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..6f071b7d2cb2 100644 --- a/doc/plugins/zipkin.md +++ b/doc/plugins/zipkin.md @@ -20,11 +20,14 @@ [Chinese](zipkin-cn.md) # Summary -- [**Name**](#name) -- [**Attributes**](#attributes) -- [**How To Enable**](#how-to-enable) -- [**Test Plugin**](#test-plugin) -- [**Disable Plugin**](#disable-plugin) +- [Summary](#summary) + - [Name](#name) + - [Attributes](#attributes) + - [How To Enable](#how-to-enable) + - [Test Plugin](#test-plugin) + - [run the Zipkin instance](#run-the-zipkin-instance) + - [Disable Plugin](#disable-plugin) + - [example code for upstream ( golang with Gin )](#example-code-for-upstream--golang-with-gin) ## Name @@ -111,7 +114,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", From e0c9c4183a9ca1410e33d6390d2407349e5f2851 Mon Sep 17 00:00:00 2001 From: Miss-you Date: Sun, 7 Jun 2020 07:33:23 +0800 Subject: [PATCH 2/3] Revert "yousali:Supplement `-H 'X-API-KEY for each interface that operates admin: edd1c9f034335f136f87ad84b625c8f1' ` parameter" This reverts commit 63d7250d515a82da3e303623b88cca69a5c49c92. --- doc/admin-api-cn.md | 18 ++++++++---------- doc/admin-api.md | 18 ++++++++---------- doc/architecture-design-cn.md | 3 +-- doc/architecture-design.md | 1 - doc/plugins/http-logger-cn.md | 2 +- doc/plugins/http-logger.md | 13 ++++++------- doc/plugins/ip-restriction-cn.md | 2 +- doc/plugins/ip-restriction.md | 15 ++++++--------- doc/plugins/kafka-logger-cn.md | 2 +- doc/plugins/kafka-logger.md | 16 +++++++--------- doc/plugins/proxy-cache-cn.md | 4 ++-- doc/plugins/proxy-cache.md | 4 ++-- doc/plugins/proxy-mirror-cn.md | 4 ++-- doc/plugins/proxy-mirror.md | 4 ++-- doc/plugins/skywalking-cn.md | 2 +- doc/plugins/skywalking.md | 19 +++++++++---------- doc/plugins/syslog-cn.md | 2 +- doc/plugins/syslog.md | 13 ++++++------- doc/plugins/tcp-logger-cn.md | 2 +- doc/plugins/tcp-logger.md | 13 ++++++------- doc/plugins/udp-logger-cn.md | 2 +- doc/plugins/udp-logger.md | 13 ++++++------- doc/plugins/zipkin-cn.md | 2 +- doc/plugins/zipkin.md | 15 ++++++--------- 24 files changed, 85 insertions(+), 104 deletions(-) diff --git a/doc/admin-api-cn.md b/doc/admin-api-cn.md index fcc375b1574b..40303f42e51e 100644 --- a/doc/admin-api-cn.md +++ b/doc/admin-api-cn.md @@ -19,13 +19,11 @@ # 目录 -- [目录](#%e7%9b%ae%e5%bd%95) - - [Route](#route) - - [运算符列表](#%e8%bf%90%e7%ae%97%e7%ac%a6%e5%88%97%e8%a1%a8) - - [Service](#service) - - [Consumer](#consumer) - - [Upstream](#upstream) - - [SSL](#ssl) +* [Route](#route) +* [Service](#service) +* [Consumer](#consumer) +* [Upstream](#upstream) +* [SSL](#ssl) ## Route @@ -216,7 +214,7 @@ serivce 对象 json 配置内容： ```shell # 创建一个Service -$ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/services/201 -X PUT -i -d ' { "plugins": { "limit-count": { @@ -296,7 +294,7 @@ consumer 对象 json 配置内容： ```shell # 创建 Consumer ，指定认证插件 key-auth ，并开启特定插件 limit-count -$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -X PUT -i -d ' { "username": "jack", "plugins": { @@ -389,7 +387,7 @@ upstream 对象 json 配置内容： ```shell # 创建一个upstream -$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d ' +$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -i -X PUT -d ' > { > "type": "roundrobin", > "nodes": { diff --git a/doc/admin-api.md b/doc/admin-api.md index d547a2068d05..4d1cc9ba708d 100644 --- a/doc/admin-api.md +++ b/doc/admin-api.md @@ -21,13 +21,11 @@ === -- [Table of Contents](#table-of-contents) - - [Route](#route) - - [Available Operators](#available-operators) - - [Service](#service) - - [Consumer](#consumer) - - [Upstream](#upstream) - - [SSL](#ssl) +* [Route](#route) +* [Service](#service) +* [Consumer](#consumer) +* [Upstream](#upstream) +* [SSL](#ssl) ## Route @@ -211,7 +209,7 @@ Config Example: Example： ```shell -$ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/services/201 -X PUT -i -d ' { "plugins": { "limit-count": { @@ -288,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d ' +$ curl http://127.0.0.1:9080/apisix/admin/consumers/2 -X PUT -i -d ' { "username": "jack", "plugins": { @@ -380,7 +378,7 @@ Config Example: Example： ```shell -$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d ' +$ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -i -X PUT -d ' > { > "type": "roundrobin", > "nodes": { diff --git a/doc/architecture-design-cn.md b/doc/architecture-design-cn.md index 3e88b4ce2d68..96c6f539519d 100644 --- a/doc/architecture-design-cn.md +++ b/doc/architecture-design-cn.md @@ -559,7 +559,6 @@ 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": { @@ -578,7 +577,7 @@ curl -X PUT \ 我们可以通过以下接口查看所有的 `GlobalRule`: ```shell -curl https://{apisix_listen_address}/apisix/admin/global_rules -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' +curl https://{apisix_listen_address}/apisix/admin/global_rules ``` [返回目录](#目录) diff --git a/doc/architecture-design.md b/doc/architecture-design.md index f2406af616ae..40ad09e19dcd 100644 --- a/doc/architecture-design.md +++ b/doc/architecture-design.md @@ -548,7 +548,6 @@ 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 b84e576d3c14..2cca9a35c035 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/http-logger.md b/doc/plugins/http-logger.md index acc58405813f..55d0bc4eb9e7 100644 --- a/doc/plugins/http-logger.md +++ b/doc/plugins/http-logger.md @@ -18,12 +18,11 @@ --> # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -86,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -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 87585740a1eb..c9f1fcfdb5cf 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' { "uri": "/index.html", "plugins": {}, diff --git a/doc/plugins/ip-restriction.md b/doc/plugins/ip-restriction.md index 4d407e6157d2..ddec4744e1d0 100644 --- a/doc/plugins/ip-restriction.md +++ b/doc/plugins/ip-restriction.md @@ -20,14 +20,11 @@ [Chinese](ip-restriction-cn.md) # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Change the restriction](#change-the-restriction) - - [Test Plugin after restriction change](#test-plugin-after-restriction-change) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -144,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -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 74b4196f2062..c7c074519d7c 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/kafka-logger.md b/doc/plugins/kafka-logger.md index eaf5c35cf2e4..1bbd83c2ee94 100644 --- a/doc/plugins/kafka-logger.md +++ b/doc/plugins/kafka-logger.md @@ -18,14 +18,12 @@ --> # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [Info](#info) - - [Sample broker list](#sample-broker-list) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**Info**](#info) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -121,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -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 3a1337443581..95f3bdaf7d0f 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-cache.md b/doc/plugins/proxy-cache.md index 618995ebbff8..c8e668c81077 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-mirror-cn.md b/doc/plugins/proxy-mirror-cn.md index 2d310d0b1396..4b3f0730cc21 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/proxy-mirror.md b/doc/plugins/proxy-mirror.md index 7f5655451af3..3b6ee542a344 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' +curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' { "uri": "/hello", "plugins": {}, diff --git a/doc/plugins/skywalking-cn.md b/doc/plugins/skywalking-cn.md index f0f09c82dbb8..a74dc84410c7 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' { "methods": ["GET"], "uris": [ diff --git a/doc/plugins/skywalking.md b/doc/plugins/skywalking.md index 8ca3830d87f0..4a3c7a4078fd 100644 --- a/doc/plugins/skywalking.md +++ b/doc/plugins/skywalking.md @@ -20,15 +20,14 @@ [Chinese](skywalking-cn.md) # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Run-Skywalking-Example](#run-skywalking-example) - - [e.g.](#eg) - - [Disable Plugin](#disable-plugin) - - [Upstream services(Code With SpringBoot)](#upstream-servicescode-with-springboot) +- [**Summary**](#Summary) + - [**Name**](#Name) + - [**Attributes**](#Attributes) + - [**How To Enable**](#How-To-Enable) + - [**Test Plugin**](#Test-Plugin) + - [**Run Skywalking Example**](#Run-Skywalking-Example) + - [**Disable Plugin**](#Disable-Plugin) + - [**Upstream services(Code With SpringBoot)**](#Upstream-services(Code-With-SpringBoot)) ## Name @@ -128,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' { "methods": ["GET"], "uris": [ diff --git a/doc/plugins/syslog-cn.md b/doc/plugins/syslog-cn.md index 486d1606424c..0dfbf7282c3a 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/syslog.md b/doc/plugins/syslog.md index ed93a0901afa..2d4307e758ac 100644 --- a/doc/plugins/syslog.md +++ b/doc/plugins/syslog.md @@ -18,12 +18,11 @@ --> # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -91,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -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 ba29772858ec..e5fa7c4a5b27 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/tcp-logger.md b/doc/plugins/tcp-logger.md index a5baa0701c33..9fd47305fa84 100644 --- a/doc/plugins/tcp-logger.md +++ b/doc/plugins/tcp-logger.md @@ -19,12 +19,11 @@ # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -96,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -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 9bdbc4f7d385..bad70ddadede 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/udp-logger.md b/doc/plugins/udp-logger.md index d3e55f3b7cb3..ad16550c5183 100644 --- a/doc/plugins/udp-logger.md +++ b/doc/plugins/udp-logger.md @@ -19,12 +19,11 @@ # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [Disable Plugin](#disable-plugin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -91,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/apisix/admin/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/hello", diff --git a/doc/plugins/zipkin-cn.md b/doc/plugins/zipkin-cn.md index 857f798b903d..ad53dc2aa569 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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/index.html", diff --git a/doc/plugins/zipkin.md b/doc/plugins/zipkin.md index 6f071b7d2cb2..b4bf4c0380b6 100644 --- a/doc/plugins/zipkin.md +++ b/doc/plugins/zipkin.md @@ -20,14 +20,11 @@ [Chinese](zipkin-cn.md) # Summary -- [Summary](#summary) - - [Name](#name) - - [Attributes](#attributes) - - [How To Enable](#how-to-enable) - - [Test Plugin](#test-plugin) - - [run the Zipkin instance](#run-the-zipkin-instance) - - [Disable Plugin](#disable-plugin) - - [example code for upstream ( golang with Gin )](#example-code-for-upstream--golang-with-gin) +- [**Name**](#name) +- [**Attributes**](#attributes) +- [**How To Enable**](#how-to-enable) +- [**Test Plugin**](#test-plugin) +- [**Disable Plugin**](#disable-plugin) ## Name @@ -114,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 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d value=' +$ curl http://127.0.0.1:2379/v2/keys/apisix/routes/1 -X PUT -d value=' { "methods": ["GET"], "uri": "/index.html", From 990ca0b79dc5eb2de09a7d1da1d0eab83b62a1e0 Mon Sep 17 00:00:00 2001 From: Miss-you Date: Sun, 7 Jun 2020 15:48:39 +0800 Subject: [PATCH 3/3] yousali:Supplement `-H 'X-API-KEY for each interface that operates admin: edd1c9f034335f136f87ad84b625c8f1' ` parameter --- doc/admin-api-cn.md | 6 +++--- doc/admin-api.md | 6 +++--- doc/architecture-design-cn.md | 3 ++- doc/architecture-design.md | 1 + doc/plugins/http-logger-cn.md | 2 +- doc/plugins/http-logger.md | 2 +- doc/plugins/ip-restriction-cn.md | 2 +- doc/plugins/ip-restriction.md | 2 +- doc/plugins/kafka-logger-cn.md | 2 +- doc/plugins/kafka-logger.md | 2 +- doc/plugins/proxy-cache-cn.md | 4 ++-- doc/plugins/proxy-cache.md | 4 ++-- doc/plugins/proxy-mirror-cn.md | 4 ++-- doc/plugins/proxy-mirror.md | 4 ++-- doc/plugins/skywalking-cn.md | 2 +- doc/plugins/skywalking.md | 2 +- doc/plugins/syslog-cn.md | 2 +- doc/plugins/syslog.md | 2 +- doc/plugins/tcp-logger-cn.md | 2 +- doc/plugins/tcp-logger.md | 2 +- doc/plugins/udp-logger-cn.md | 2 +- doc/plugins/udp-logger.md | 2 +- doc/plugins/zipkin-cn.md | 2 +- doc/plugins/zipkin.md | 2 +- 24 files changed, 33 insertions(+), 31 deletions(-) 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",