You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2022/07/05 07:24:56 UTC

[apisix] branch master updated: docs: add more architecture description (#7380)

This is an automated email from the ASF dual-hosted git repository.

juzhiyuan 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 8d81d42cd docs: add more architecture description (#7380)
8d81d42cd is described below

commit 8d81d42cd63e71192cce44ef0ad706534aa2c67b
Author: Zeping Bai <bz...@apache.org>
AuthorDate: Tue Jul 5 15:24:52 2022 +0800

    docs: add more architecture description (#7380)
---
 docs/en/latest/architecture-design/apisix.md | 11 +++++++++++
 docs/zh/latest/architecture-design/apisix.md | 11 +++++++++++
 2 files changed, 22 insertions(+)

diff --git a/docs/en/latest/architecture-design/apisix.md b/docs/en/latest/architecture-design/apisix.md
index 8eff707ba..0a6139c6f 100644
--- a/docs/en/latest/architecture-design/apisix.md
+++ b/docs/en/latest/architecture-design/apisix.md
@@ -25,6 +25,17 @@ title: APISIX
 
 ![flow-software-architecture](../../../assets/images/flow-software-architecture.png)
 
+Apache APISIX is a dynamic, real-time, high-performance cloud-native API gateway. It is built on top of NGINX + ngx_lua technology and leverages the power offered by LuaJIT. [Why Apache APISIX chose Nginx and Lua to build API Gateway?](https://apisix.apache.org/blog/2021/08/25/why-apache-apisix-chose-nginx-and-lua/)
+
+APISIX is divided into two main parts:
+
+1. APISIX core, including Lua plugin, multi-language plugin runtime, Wasm plugin runtime, etc.
+2. Feature-rich variety of built-in plugins: including observability, security, traffic control, etc.
+
+In the APISIX core, important functions such as route matching, load balancing, service discovery, management API, and basic modules such as configuration management are provided. In addition, APISIX plugin runtime is also included, providing the runtime framework for native Lua plugins and multilingual plugins, as well as the experimental Wasm plugin runtime, etc. APISIX multilingual plugin runtime provides support for various development languages, such as Golang, Java, Python, JS, etc.
+
+APISIX currently has various plugins built in, covering various areas of API gateways, such as authentication and authentication, security, observability, traffic management, multi-protocol access, and so on. The plugins currently built into APISIX are implemented using native Lua. For the introduction and usage of each plugin, please check the [documentation](https://apisix.apache.org/docs/apisix/plugins/batch-requests) of the relevant plugin.
+
 ## Plugin Loading Process
 
 ![flow-load-plugin](../../../assets/images/flow-load-plugin.png)
diff --git a/docs/zh/latest/architecture-design/apisix.md b/docs/zh/latest/architecture-design/apisix.md
index cd2e57bc3..428a40fce 100644
--- a/docs/zh/latest/architecture-design/apisix.md
+++ b/docs/zh/latest/architecture-design/apisix.md
@@ -25,6 +25,17 @@ title: APISIX
 
 ![软件架构](../../../assets/images/flow-software-architecture.png)
 
+Apache APISIX 是一个动态、实时、高性能的云原生 API 网关。它构建于 NGINX + ngx_lua 的技术基础之上,充分利用了 LuaJIT 所提供的强大性能。 [为什么 Apache APISIX 选择 NGINX+Lua 技术栈?](https://apisix.apache.org/zh/blog/2021/08/25/why-apache-apisix-chose-nginx-and-lua/)。
+
+APISIX 主要分为两个部分:
+
+1. APISIX 核心:包括 Lua 插件、多语言插件运行时(Plugin Runner)、Wasm 插件运行时等;
+2. 功能丰富的各种内置插件:包括可观测性、安全、流量控制等。
+
+APISIX 在其核心中,提供了路由匹配、负载均衡、服务发现、API 管理等重要功能,以及配置管理等基础性模块。除此之外,APISIX 插件运行时也包含其中,提供原生 Lua 插件的运行框架和多语言插件的运行框架,以及实验性的 Wasm 插件运行时等。APISIX 多语言插件运行时提供多种开发语言的支持,比如 Golang、Java、Python、JS 等。
+
+APISIX 目前也内置了各类插件,覆盖了 API 网关的各种领域,如认证鉴权、安全、可观测性、流量管理、多协议接入等。当前 APISIX 内置的插件使用原生 Lua 实现,关于各个插件的介绍与使用方式,可以查看相关[插件文档](https://apisix.apache.org/docs/apisix/plugins/batch-requests)。
+
 ## 插件加载流程
 
 ![插件加载流程](../../../assets/images/flow-load-plugin.png)