test/apisix
1
0
Fork 0
mirror of https://gitee.com/iresty/apisix.git synced 2024-12-09 15:37:40 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: fixed some typo and incorrect examples in getting-started.md and syslog.md (#2458)

Browse Source 
fix #2457
This commit is contained in:
dabue 2020-10-28 22:24:32 +08:00 committed by GitHub
parent 146e222e0c
commit e472d2c2db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/getting-started.md
View File

@ -237,7 +237,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
Now you can invoke the route with the following command: Now you can invoke the route with the following command:
```bash ```bash
curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey' curl -i -X GET 'http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar' -H 'apikey: superSecretAPIKey'
``` ```
## APISIX Dashboard ## APISIX Dashboard

33
doc/plugins/syslog.md
View File

@ -57,25 +57,22 @@ This will provide the ability to send Log data requests as JSON objects.
The following is an example on how to enable the sys-logger for a specific route. The following is an example on how to enable the sys-logger for a specific route.
```shell ```shell
curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{ {
"username": "foo",
"plugins": { "plugins": {
"plugins": { "syslog": {
"syslog": { "host" : "127.0.0.1",
"host" : "127.0.0.1", "port" : 5044,
"port" : 5044, "flush_limit" : 1
"flush_limit" : 1 }
} },
}, "upstream": {
"upstream": { "type": "roundrobin",
"type": "roundrobin", "nodes": {
"nodes": { "127.0.0.1:1980": 1
"127.0.0.1:1980": 1 }
} },
}, "uri": "/hello"
"uri": "/hello"
}
}' }'
``` ```
@ -96,7 +93,7 @@ Remove the corresponding json configuration in the plugin configuration to disab
APISIX plugins are hot-reloaded, therefore no need to restart APISIX. APISIX plugins are hot-reloaded, therefore no need to restart APISIX.
```shell ```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:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{ {
"methods": ["GET"], "methods": ["GET"],
"uri": "/hello", "uri": "/hello",

2
doc/zh-cn/getting-started.md
View File

@ -232,7 +232,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
现在可以使用以下命令调用路由： 现在可以使用以下命令调用路由：
```bash ```bash
curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar -H 'apikey: superSecretAPIKey' curl -i -X GET 'http://127.0.0.1:9080/samplePrefix/get?param1=foo&param2=bar' -H 'apikey: superSecretAPIKey'
``` ```
## Apache APISIX 控制台 ## Apache APISIX 控制台

33
doc/zh-cn/plugins/syslog.md
View File

@ -57,25 +57,22 @@
1. 下面例子展示了如何为指定路由开启 `sys-logger` 插件的。 1. 下面例子展示了如何为指定路由开启 `sys-logger` 插件的。
```shell ```shell
curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{ {
"username": "foo",
"plugins": { "plugins": {
"plugins": { "syslog": {
"syslog": { "host" : "127.0.0.1",
"host" : "127.0.0.1", "port" : 5044,
"port" : 5044, "flush_limit" : 1
"flush_limit" : 1 }
} },
}, "upstream": {
"upstream": { "type": "roundrobin",
"type": "roundrobin", "nodes": {
"nodes": { "127.0.0.1:1980": 1
"127.0.0.1:1980": 1 }
} },
}, "uri": "/hello"
"uri": "/hello"
}
}' }'
``` ```
@ -96,7 +93,7 @@ hello, world
想要禁用“sys-logger”插件，是非常简单的，将对应的插件配置从json配置删除，就会立即生效，不需要重新启动服务： 想要禁用“sys-logger”插件，是非常简单的，将对应的插件配置从json配置删除，就会立即生效，不需要重新启动服务：
```shell ```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:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{ {
"methods": ["GET"], "methods": ["GET"],
"uri": "/hello", "uri": "/hello",