Apache APISIX Go Plugin Runner 使用指南

Apache APISIX Go Plugin Runner 使用指南

apisix-go-plugin-runnerGo Plugin Runner for APISIX项目地址:https://gitcode.com/gh_mirrors/ap/apisix-go-plugin-runner

1. 项目介绍

Apache APISIX Go Plugin Runner 是一个专为 Apache APISIX 设计的插件运行器，它允许开发者以 Go 语言编写外部插件。该工具让开发和集成自定义逻辑变得更加灵活和高效。当你在 APISIX 中配置了 Go Plugin Runner，APISIX 将其视为子进程管理，通过 Unix 套接字进行RPC调用来执行预请求（ext-plugin-pre-req）等阶段的插件逻辑。这种方式支持热重启并简化了多语言插件的管理。

2. 项目快速启动

环境准备

确保你的系统中安装了 Go，并设置好了 GOPATH 或使用 Go Modules。

步骤一：编译示例代码

首先，克隆 apisix-go-plugin-runner 项目:

git clone https://github.com/apache/apisix-go-plugin-runner.git
cd apisix-go-plugin-runner

然后，编译生成可执行文件：

make build

这将生成名为 go-runner 的可执行文件。

步骤二：配置 Apache APISIX

编辑 Apache APISIX 的 conf/config.yaml 文件，添加 Go Plugin Runner 配置：

ext-plugin:
  cmd: ["/path/to/go-runner"]

替换 /path/to/go-runner 为你实际生成的可执行文件路径。

步骤三：启动 Apache APISIX

确保 APISIX 的配置正确引用了插件运行器后，正常启动 APISIX。此时，APISIX 启动时会一同拉起 Go Plugin Runner。

3. 应用案例和最佳实践

开发自定义插件通常涉及以下几个步骤：

1. 创建插件：在 cmd/go-runner/plugins 目录下创建一个新的目录来存放你的插件代码。
2. 实现接口：遵循 Go Plugin Runner 提供的接口来实现特定功能，例如请求处理前的预处理逻辑。
3. 配置插件：在 APISIX 的路由或服务配置中启用并配置你的插件。
4. 测试与调试：利用独立运行模式或者调整 APISIX 的配置以便于开发中的快速迭代。

例如，如果你需要一个简单的日志插件，模仿 say 插件的结构来实现。

4. 典型生态项目

Apache APISIX 生态不仅仅局限于 Go Plugin Runner，还包括但不限于：

• Apache APISIX Ingress Controller：用于在 Kubernetes 上管理和配置 Apache APISIX 路由和服务。
• Java Plugin Runner 和 Python Plugin Runner：为不同编程语言提供类似功能的插件运行器。
• Apache APISIX Dashboard：提供了直观的Web界面来管理 APISIX 实例。
• Helm Charts 和 Docker 支持，方便容器化部署和管理。

通过这些生态项目，开发者可以灵活地选择适合自身技术栈的方式来扩展和管理 API 网关的功能。

---

以上是基于 apisix-go-plugin-runner 的快速入门指导，深入学习和更高级的应用需要参考其官方文档及社区资源。

apisix-go-plugin-runnerGo Plugin Runner for APISIX项目地址:https://gitcode.com/gh_mirrors/ap/apisix-go-plugin-runner