You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/07/05 09:26:34 UTC
[GitHub] [apisix] tao12345666333 commented on a change in pull request #4535: docs: update EN FAQ
tao12345666333 commented on a change in pull request #4535:
URL: https://github.com/apache/apisix/pull/4535#discussion_r663777845
##########
File path: docs/en/latest/FAQ.md
##########
@@ -92,7 +92,7 @@ There are two different ways to do this：
1. Use the `vars` field of route to do it.
```shell
-curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9080/Apache APISIX/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
```suggestion
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
```
##########
File path: docs/en/latest/FAQ.md
##########
@@ -105,7 +105,7 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}
}'
-curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9080/Apache APISIX/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
```suggestion
curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
```
##########
File path: docs/en/latest/FAQ.md
##########
@@ -25,33 +25,33 @@ title: FAQ
There are new requirements for API gateways in the field of microservices: higher flexibility, higher performance requirements, and cloud native.
-## What are the differences between APISIX and other API gateways?
+## What are the differences between Apache APISIX and other API gateways?
-APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
+Apache APISIX is based on etcd to save and synchronize configuration, not relational databases such as Postgres or MySQL.
This not only eliminates polling, makes the code more concise, but also makes configuration synchronization more real-time. At the same time, there will be no single point in the system, which is more usable.
-In addition, APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
+In addition, Apache APISIX has dynamic routing and hot loading of plug-ins, which is especially suitable for API management under micro-service system.
-## What's the performance of APISIX?
+## What's the performance of Apache APISIX?
-One of the goals of APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](benchmark.md)
+One of the goals of Apache APISIX design and development is the highest performance in the industry. Specific test data can be found here：[benchmark](benchmark.md)
-APISIX is the highest performance API gateway with a single-core QPS of 23,000, with an average delay of only 0.6 milliseconds.
+Apache APISIX is the highest performance API gateway with a single-core QPS of 23,000, with an average delay of only 0.6 milliseconds.
-## Does APISIX have a console interface?
+## Does Apache APISIX have a user interface？
-Yes, APISIX has a powerful Dashboard. APISIX and [APISIX Dashboard](https://github.com/apache/apisix-dashboard) are independent projects, you can deploy [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to operate APISIX through the web interface.
+Yes. Apache APISIX has an experimental feature called [Apache APISIX Dashboard](https://github.com/apache/Apache APISIX-dashboard), which is an independent project apart from Apache APISIX. You can deploy Apache APISIX Dashboard to operate Apache APISIX through the user interface.
Review comment:
```suggestion
Yes. Apache APISIX has an experimental feature called [Apache APISIX Dashboard](https://github.com/apache/apisix-dashboard), which is an independent project apart from Apache APISIX. You can deploy Apache APISIX Dashboard to operate Apache APISIX through the user interface.
```
##########
File path: docs/en/latest/FAQ.md
##########
@@ -173,7 +173,7 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f03433
3. `serverless` plugin：
```shell
-curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9080/Apache APISIX/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -150,7 +150,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
2. Use with advanced routing rule `vars` with `redirect` plugin:
```shell
-curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9080/Apache APISIX/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -135,7 +135,7 @@ There are several different ways to do this.
1. Directly use the `http_to_https` in `redirect` 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/Apache APISIX/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -224,23 +224,23 @@ nginx_config:
error_log_level: "info"
```
-2. Reload or restart APISIX
+2. Reload or restart Apache APISIX
Now you can trace the info level log in logs/error.log.
## How to reload your own plugin?
-The Apache APISIX plugin supports hot reloading.
+The Apache Apache APISIX plugin supports hot reloading.
See the `Hot reload` section in [plugins](./plugins.md) for how to do that.
-## How to make APISIX listen on multiple ports when handling HTTP or HTTPS requests?
+## How to make Apache APISIX listen on multiple ports when handling HTTP or HTTPS requests?
-By default, APISIX only listens on port 9080 when handling HTTP requests. If you want APISIX to listen on multiple ports, you need to modify the relevant parameters in the configuration file as follows:
+By default, Apache APISIX only listens on port 9080 when handling HTTP requests. If you want Apache APISIX to listen on multiple ports, you need to modify the relevant parameters in the configuration file as follows:
1. Modify the parameter of HTTP port listen `node_listen` in `conf/config.yaml`, for example:
```
- apisix:
+ Apache APISIX:
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -335,26 +335,26 @@ Example: luarocks install luasec OPENSSL_DIR=/usr/local
make: *** [deps] Error 1
```
-## How to access APISIX Dashboard through APISIX proxy
+## How to access Apache APISIX Dashboard through Apache APISIX proxy
-1. Keep the APISIX proxy port and Admin API port different(or disable Admin API). For example, do the following configuration in `conf/config.yaml`.
+1. Keep the Apache APISIX proxy port and Admin API port different(or disable Admin API). For example, do the following configuration in `conf/config.yaml`.
The Admin API use a separate port 9180:
```yaml
-apisix:
+Apache APISIX:
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -250,41 +250,41 @@ By default, APISIX only listens on port 9080 when handling HTTP requests. If you
Handling HTTPS requests is similar, modify the parameter of HTTPS port listen `ssl.listen_port` in `conf/config.yaml`, for example:
```
- apisix:
+ Apache APISIX:
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -335,26 +335,26 @@ Example: luarocks install luasec OPENSSL_DIR=/usr/local
make: *** [deps] Error 1
```
-## How to access APISIX Dashboard through APISIX proxy
+## How to access Apache APISIX Dashboard through Apache APISIX proxy
-1. Keep the APISIX proxy port and Admin API port different(or disable Admin API). For example, do the following configuration in `conf/config.yaml`.
+1. Keep the Apache APISIX proxy port and Admin API port different(or disable Admin API). For example, do the following configuration in `conf/config.yaml`.
The Admin API use a separate port 9180:
```yaml
-apisix:
+Apache APISIX:
port_admin: 9180 # use a separate port
```
-2. Add proxy route of APISIX Dashboard:
+2. Add proxy route of Apache APISIX Dashboard:
-Note: The APISIX Dashboard service here is listening on `127.0.0.1:9000`.
+Note: The Apache APISIX Dashboard service here is listening on `127.0.0.1:9000`.
```shell
-curl -i http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+curl -i http://127.0.0.1:9180/Apache APISIX/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -200,7 +200,7 @@ Content-Type: text/html
Content-Length: 166
Connection: keep-alive
Location: https://foo.com/hello
-Server: APISIX web server
+Server: Apache APISIX web server
Review comment:
```suggestion
Server: APISIX web server
```
##########
File path: docs/en/latest/FAQ.md
##########
@@ -250,41 +250,41 @@ By default, APISIX only listens on port 9080 when handling HTTP requests. If you
Handling HTTPS requests is similar, modify the parameter of HTTPS port listen `ssl.listen_port` in `conf/config.yaml`, for example:
```
- apisix:
+ Apache APISIX:
ssl:
listen_port:
- 9443
- 9444
- 9445
```
-2. Reload or restart APISIX
+2. Reload or restart Apache APISIX
-## How does APISIX use etcd to achieve millisecond-level configuration synchronization
+## How does Apache APISIX use etcd to achieve millisecond-level configuration synchronization
etcd provides subscription functions to monitor whether the specified keyword or directory is changed (for example: [watch](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watch), [watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir)).
-APISIX uses [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) to monitor directory content changes:
+Apache APISIX uses [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) to monitor directory content changes:
* If there is no data update in the monitoring directory: the process will be blocked until timeout or other errors occurred.
-* If the monitoring directory has data updates: etcd will return the new subscribed data immediately (in milliseconds), and APISIX will update it to the memory cache.
+* If the monitoring directory has data updates: etcd will return the new subscribed data immediately (in milliseconds), and Apache APISIX will update it to the memory cache.
-With the help of etcd which incremental notification feature is millisecond-level, APISIX achieve millisecond-level of configuration synchronization.
+With the help of etcd which incremental notification feature is millisecond-level, Apache APISIX achieve millisecond-level of configuration synchronization.
-## How to customize the APISIX instance id?
+## How to customize the Apache APISIX instance id?
-By default, APISIX will read the instance id from `conf/apisix.uid`. If it is not found, and no id is configured, APISIX will generate a `uuid` as the instance id.
+By default, Apache APISIX will read the instance id from `conf/Apache APISIX.uid`. If it is not found, and no id is configured, Apache APISIX will generate a `uuid` as the instance id.
Review comment:
ditto
##########
File path: docs/en/latest/FAQ.md
##########
@@ -250,41 +250,41 @@ By default, APISIX only listens on port 9080 when handling HTTP requests. If you
Handling HTTPS requests is similar, modify the parameter of HTTPS port listen `ssl.listen_port` in `conf/config.yaml`, for example:
```
- apisix:
+ Apache APISIX:
ssl:
listen_port:
- 9443
- 9444
- 9445
```
-2. Reload or restart APISIX
+2. Reload or restart Apache APISIX
-## How does APISIX use etcd to achieve millisecond-level configuration synchronization
+## How does Apache APISIX use etcd to achieve millisecond-level configuration synchronization
etcd provides subscription functions to monitor whether the specified keyword or directory is changed (for example: [watch](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watch), [watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir)).
-APISIX uses [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) to monitor directory content changes:
+Apache APISIX uses [etcd.watchdir](https://github.com/api7/lua-resty-etcd/blob/master/api_v3.md#watchdir) to monitor directory content changes:
* If there is no data update in the monitoring directory: the process will be blocked until timeout or other errors occurred.
-* If the monitoring directory has data updates: etcd will return the new subscribed data immediately (in milliseconds), and APISIX will update it to the memory cache.
+* If the monitoring directory has data updates: etcd will return the new subscribed data immediately (in milliseconds), and Apache APISIX will update it to the memory cache.
-With the help of etcd which incremental notification feature is millisecond-level, APISIX achieve millisecond-level of configuration synchronization.
+With the help of etcd which incremental notification feature is millisecond-level, Apache APISIX achieve millisecond-level of configuration synchronization.
-## How to customize the APISIX instance id?
+## How to customize the Apache APISIX instance id?
-By default, APISIX will read the instance id from `conf/apisix.uid`. If it is not found, and no id is configured, APISIX will generate a `uuid` as the instance id.
+By default, Apache APISIX will read the instance id from `conf/Apache APISIX.uid`. If it is not found, and no id is configured, Apache APISIX will generate a `uuid` as the instance id.
-If you want to specify a meaningful id to bind APISIX instance to your internal system, you can configure it in `conf/config.yaml`, for example:
+If you want to specify a meaningful id to bind Apache APISIX instance to your internal system, you can configure it in `conf/config.yaml`, for example:
```
- apisix:
+ Apache APISIX:
Review comment:
ditto
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org