You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by me...@apache.org on 2020/11/08 03:45:04 UTC
[apisix] branch master updated: docs: put the chapter "admin api"
to the front, and sync the Chinese version from English version (#2650)
This is an automated email from the ASF dual-hosted git repository.
membphis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 021f24a docs: put the chapter "admin api" to the front, and sync the Chinese version from English version (#2650)
021f24a is described below
commit 021f24a7b2369760382db300758918326217981b
Author: YuanSheng Wang <me...@gmail.com>
AuthorDate: Sun Nov 8 11:44:54 2020 +0800
docs: put the chapter "admin api" to the front, and sync the Chinese version from English version (#2650)
---
doc/README.md | 40 ++++++++++++------------
doc/zh-cn/README.md | 87 +++++++++++++++++++++++++++++++++--------------------
2 files changed, 75 insertions(+), 52 deletions(-)
diff --git a/doc/README.md b/doc/README.md
index 9a1c2c3..e505738 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -17,59 +17,61 @@
#
-->
-[Chinese](./zh-cn/README.md)
+* [Chinese](./zh-cn/README.md)
-Reference Documentation
-==================
+## Reference Documentation
* [APISIX Readme](./README.md)
* [Architecture Design](architecture-design.md)
-* [Benchmark](benchmark.md)
* [Getting Started Guide](getting-started.md)
* [How to build Apache APISIX](how-to-build.md)
+* [Admin API](admin-api.md)
* [Health Check](health-check.md): Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
* [Router radixtree](router-radixtree.md)
* [Stand Alone Model](stand-alone.md): Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
* [Stream Proxy](stream-proxy.md)
* [gRPC Proxy](grpc-proxy.md)
-* [Admin API](admin-api.md)
* [Changelog](../CHANGELOG.md)
+* [Benchmark](benchmark.md)
* [Code Style](../CODE_STYLE.md)
* [FAQ](../FAQ.md)
-Plugins
-=======
+## Plugins
+
+### General
-**General**
* [batch-requests](plugins/batch-requests.md): Allow you send mutiple http api via **http pipeline**.
* [hot reload](plugins.md): Hot reload without reload service.
* [HTTPS/TLS](https.md): Dynamic load the SSL Certificate by Server Name Indication (SNI).
* [serverless](plugins/serverless.md)：Allows to dynamically run Lua code at *different* phase in APISIX.
* [redirect](plugins/redirect.md): URI redirect.
-**Transformation**
+### Transformation
+
* [response-rewrite](plugins/response-rewrite.md): Set customized response status code, body and header to the client.
* [proxy-rewrite](plugins/proxy-rewrite.md): Rewrite upstream request information.
* [grpc-transcode](plugins/grpc-transcode.md): REST <--> gRPC transcoding.
* [fault-injection](plugins/fault-injection.md): The specified response body, response code, and response time can be returned, which provides processing capabilities in different failure scenarios, such as service failure, service overload, and high service delay.
-**Authentication**
+### Authentication
+
* [key-auth](plugins/key-auth.md): User authentication based on Key Authentication.
* [JWT-auth](plugins/jwt-auth.md): User authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
* [basic-auth](plugins/basic-auth.md): User authentication based on Basic Authentication.
* [oauth](plugins/oauth.md): Provides OAuth 2 authentication and introspection.
-
-**Authorization**
* [authz-keycloak](plugins/authz-keycloak.md): Authorization with Keycloak Identity Server.
* [wolf-rbac](plugins/wolf-rbac.md) User Authentication and Authorization based on *RBAC*.
+* [openid-connect](plugins/openid-connect.md)
+
+### Security
-**Security**
* [cors](plugins/cors.md): Enable CORS(Cross-origin resource sharing) for your API.
* [uri-blocker](plugins/uri-blocker.md): Block client request by URI.
* [ip-restriction](plugins/ip-restriction.md): IP whitelist/blacklist.
* [referer-restriction](plugins/referer-restriction.md): Referer whitelist.
-**Traffic**
+### Traffic
+
* [limit-req](plugins/limit-req.md): Request rate limiting and adjustment based on the "leaky bucket" method.
* [limit-conn](plugins/limit-conn.md): Limite request concurrency (or concurrent connections).
* [limit-count](plugins/limit-count.md): Rate limiting based on a "fixed window" implementation.
@@ -78,12 +80,14 @@ Plugins
* [proxy-mirror](plugins/proxy-mirror.md): Provides the ability to mirror client requests.
* [api-breaker](plugins/api-breaker.md): Circuit Breaker for API that stops requests forwarding to upstream in case of unhealthy state.
-**Monitoring**
+### Monitoring
+
* [prometheus](plugins/prometheus.md): Expose metrics related to APISIX and proxied upstream services in Prometheus exposition format, which can be scraped by a Prometheus Server.
* [OpenTracing](plugins/zipkin.md): Supports Zikpin and Apache SkyWalking.
* [Skywalking](plugins/skywalking.md): Supports Apache SkyWalking.
-**Loggers**
+### Loggers
+
* [http-logger](plugins/http-logger.md): Log requests to http servers.
* [tcp-logger](plugins/tcp-logger.md): Log requests to TCP servers.
* [kafka-logger](plugins/kafka-logger.md): Log requests to External Kafka servers.
@@ -91,8 +95,7 @@ Plugins
* [sys-log](plugins/syslog.md): Log requests to Syslog.
* [log-rotate](plugins/log-rotate.md): Rotate access/error log files.
-Deploy
-=======
+## Deploy
### AWS
@@ -103,4 +106,3 @@ See [this guide](https://github.com/pahud/cdk-samples/blob/master/typescript/api
### Kubernetes
See [this guide](../kubernetes/README.md) and learn how to deploy apisix in Kubernetes.
-
diff --git a/doc/zh-cn/README.md b/doc/zh-cn/README.md
index b6ddbb2..c562d10 100644
--- a/doc/zh-cn/README.md
+++ b/doc/zh-cn/README.md
@@ -16,64 +16,86 @@
# limitations under the License.
#
-->
-[English](../README.md)
-参考文档
-==================
+* [English](../README.md)
+
+## 参考文档
* [APISIX 说明](../../README_CN.md)
* [架构设计](architecture-design.md)
-* [压力测试](benchmark.md)
* [如何构建 Apache APISIX](how-to-build.md)
+* [管理 API](admin-api.md)
* [健康检查](health-check.md): 支持对上游节点的主动和被动健康检查，在负载均衡时自动过滤掉不健康的节点。
* [路由 radixtree](../router-radixtree.md)
* [独立运行模型](stand-alone.md): 支持从本地 yaml 格式的配置文件启动，更适合 Kubernetes(k8s) 体系。
* [TCP/UDP 动态代理](stream-proxy.md)
* [gRPC 代理](grpc-proxy.md)
-* [管理 API](admin-api.md)
* [变更日志](../../CHANGELOG_CN.md)
+* [压力测试](benchmark.md)
* [代码风格](../../CODE_STYLE_CN.md)
* [常见问答](../../FAQ_CN.md)
-插件
-===
+## 插件
+
+### General
+* [batch-requests](plugins/batch-requests.md): 以 **http pipeline** 的方式在网关一次性发起多个 `http` 请求。
* [插件热加载](plugins.md)：无需重启服务，完成插件热加载或卸载。
-* [HTTPS](https.md)：根据 TLS 扩展字段 SNI(Server Name Indication) 动态加载证书。
-* [动态负载均衡](architecture-design.md#upstream)：跨多个上游服务的动态负载均衡，目前已支持 round-robin 和一致性哈希算法。
+* [HTTPS/TLS](https.md)：根据 TLS 扩展字段 SNI(Server Name Indication) 动态加载证书。
+* [serverless](plugins/serverless.md)：允许在 APISIX 中的不同阶段动态运行 Lua 代码。
+* [redirect](plugins/redirect.md): URI 重定向。
+
+### Transformation
+
+* [response-rewrite](plugins/response-rewrite.md): 支持自定义修改返回内容的 `status code`、`body`、`headers`。
+* [proxy-rewrite](plugins/proxy-rewrite.md): 支持自定义修改 proxy 到上游的信息。
+* [grpc-transcode](plugins/grpc-transcode.md)：REST <--> gRPC 转码。
+* [fault-injection](plugins/fault-injection.md)：故障注入，可以返回指定的响应体、响应码和响应时间，从而提供了不同的失败场景下处理的能力，例如服务失败、服务过载、服务高延时等。
+
+### Authentication
+
+* [authz-keycloak](plugins/authz-keycloak.md): 支持 Keycloak 身份认证服务器
+* [wolf-rbac](plugins/wolf-rbac.md) 基于 *RBAC* 的用户认证及授权。
* [key-auth](plugins/key-auth.md)：基于 Key Authentication 的用户认证。
* [JWT-auth](plugins/jwt-auth.md)：基于 [JWT](https://jwt.io/) (JSON Web Tokens) Authentication 的用户认证。
* [basic-auth](plugins/basic-auth.md)：基于 basic auth 的用户认证。
-* [wolf-rbac](plugins/wolf-rbac.md) 基于 *RBAC* 的用户认证及授权。
-* [limit-count](plugins/limit-count.md)：基于“固定窗口”的限速实现。
+* [oauth](plugins/openid-connect.md): 提供 OAuth 2 身份验证和自省。
+* [openid-connect](plugins/openid-connect.md)
+
+### Security
+
+* [cors](plugins/cors.md): 为你的API启用 CORS
+* [uri-blocker](plugins/uri-blocker.md): 根据 URI 拦截用户请求。
+
+* [referer-restriction](plugins/referer-restriction.md): Referer 白名单。
+* [ip-restriction](plugins/ip-restriction.md): IP 黑白名单。
+
+### Traffic
+
* [limit-req](plugins/limit-req.md)：基于漏桶原理的请求限速实现。
* [limit-conn](plugins/limit-conn.md)：限制并发请求（或并发连接）。
-* [proxy-rewrite](plugins/proxy-rewrite.md): 支持自定义修改 proxy 到上游的信息。
-* [prometheus](plugins/prometheus.md)：以 Prometheus 格式导出 APISIX 自身的状态信息，方便被外部 Prometheus 服务抓取。
-* [OpenTracing](plugins/zipkin.md)：支持 Zikpin 和 Apache SkyWalking。
-* [grpc-transcode](plugins/grpc-transcode.md)：REST <--> gRPC 转码。
-* [serverless](plugins/serverless.md)：允许在 APISIX 中的不同阶段动态运行 Lua 代码。
-* [ip-restriction](plugins/ip-restriction.md): IP 黑白名单。
-* [referer-restriction](plugins/referer-restriction.md): Referer 白名单。
-* [openid-connect](plugins/openid-connect.md)
-* [redirect](plugins/redirect.md): URI 重定向。
-* [response-rewrite](plugins/response-rewrite.md): 支持自定义修改返回内容的 `status code`、`body`、`headers`。
-* [fault-injection](plugins/fault-injection.md)：故障注入，可以返回指定的响应体、响应码和响应时间，从而提供了不同的失败场景下处理的能力，例如服务失败、服务过载、服务高延时等。
+* [limit-count](plugins/limit-count.md)：基于“固定窗口”的限速实现。
* [proxy-cache](plugins/proxy-cache.md)：代理缓存插件提供缓存后端响应数据的能力。
+* [request-validation](plugins/request-validation.md): 请求验证。
* [proxy-mirror](plugins/proxy-mirror.md)：代理镜像插件提供镜像客户端请求的能力。
-* [udp-logger](plugins/udp-logger.md): 将请求记录到 UDP 服务器
-* [tcp-logger](plugins/tcp-logger.md): 将请求记录到 TCP 服务器
+* [api-breaker](plugins/api-breaker.md): API的断路器，在状态不正常的情况下停止将请求转发到上游。
+
+### Monitoring
+
+* [prometheus](plugins/prometheus.md)：以 Prometheus 格式导出 APISIX 自身的状态信息，方便被外部 Prometheus 服务抓取。
+* [OpenTracing](plugins/zipkin.md)：支持 Zikpin 和 Apache SkyWalking。
+* [Skywalking](plugins/skywalking.md): Supports Apache SkyWalking.
+
+### Loggers
+
+* [http-logger](plugins/http-logger.md): 将请求记录到 HTTP 服务器。
+* [tcp-logger](plugins/tcp-logger.md): 将请求记录到 TCP 服务器。
* [kafka-logger](plugins/kafka-logger.md): 将请求记录到外部 Kafka 服务器。
-* [cors](plugins/cors.md): 为你的API启用 CORS
-* [batch-requests](plugins/batch-requests.md): 以 **http pipeline** 的方式在网关一次性发起多个 `http` 请求。
-* [authz-keycloak](plugins/authz-keycloak.md): 支持 Keycloak 身份认证服务器
-* [uri-blocker](plugins/uri-blocker.md): 根据 URI 拦截用户请求。
-* [oauth](plugins/openid-connect.md): 提供 OAuth 2 身份验证和自省。
+* [udp-logger](plugins/udp-logger.md): 将请求记录到 UDP 服务器。
+* [sys-log](plugins/syslog.md): 将请求记录到 syslog 服务。
* [log-rotate](plugins/log-rotate.md): 日志文件定期切分。
-* [api-breaker](plugins/api-breaker.md): API的断路器，在状态不正常的情况下停止将请求转发到上游。
-部署
-=======
+## 部署
### AWS
@@ -84,4 +106,3 @@
### Kubernetes
请参阅[指南](../../kubernetes/README.md)并了解如何在 Kubernetes 中部署 APISIX。
-