ghcr.io/api7/adc:0.25.0

API 声明式 CLI (ADC)

ADC 是一个命令行工具，用于与 API7 Enterprise 和 Apache APISIX 管理 API 交互。

支持的后端

ADC 支持以下后端类型：

• API7 Enterprise
• Apache APISIX

支持的转换器

支持以下转换器将 API 规范转换为 ADC 配置：

• OpenAPI Spec 3

安装

安装 ADC 最简单的方法是通过安装脚本：

curl -sL "https://run.api7.ai/adc/install" | sh

或者，您可以从发布页面下载相应的二进制文件：

目前提供适用于 Linux、Windows 和 macOS 的 amd64 和 arm64 预构建二进制文件。

amd64 arm64

配置 ADC

您可以通过环境变量或命令行标志配置 ADC。运行 adc help [command] 以查看命令的可用配置选项。

adc help [command]

ADC 支持 dotenv，因此您可以在 .env 文件中存储和使用环境变量。以下示例展示了如何为 API7 Enterprise 和 Apache APISIX 后端配置 ADC。

.env

API7 Enterprise 配置示例

ADC_BACKEND=api7ee
ADC_SERVER=https://localhost:7443
ADC_TOKEN=

Apache APISIX 配置示例

ADC_SERVER=http://localhost:9180
ADC_TOKEN=

使用方法

本节重点介绍一些常用的 ADC 命令。

检查连接性

ping 命令通过尝试连接到已配置的后端来验证配置：

ping

adc ping

以 ADC 格式导出配置

dump 命令获取后端的当前配置并将其保存为 ADC 配置文件格式：

dump

adc dump -o adc.yaml

显示本地与远程配置的差异

diff 命令将指定 ADC 配置文件中的配置与后端的当前配置进行比较：

diff

adc diff -f adc.yaml

同步本地配置

sync 命令将指定 ADC 配置文件中的配置与后端同步：

sync

adc sync -f adc.yaml

转换 API 规范

convert 命令将 API 规范转换为 ADC 配置。目前，它支持将 OpenAPI 3 规范转换为 ADC 配置。

convert

adc convert openapi -f openapi.yaml

验证 ADC 配置

lint 命令在本地验证提供的 ADC 配置文件。

lint

adc lint -f adc.yaml

开发

要从源代码构建 ADC，请安装 Nx 并运行：

pnpm install
nx build cli

要使用二进制文件，请运行：

node dist/apps/cli/main.cjs -h

许可证

本项目采用 Apache 2.0 许可证。