跳到主要内容

APISIX 声明式 CLI(ADC)

API 声明式 CLI(ADC)使用本地 YAML 或 JSON 文件管理 Apache APISIX 配置。

本文介绍 ADC 在 Apache APISIX 配置管理中的作用。有关安装、命令用法、配置格式、OpenAPI 转换和其他参考资料,请参阅 ADC 文档

以代码方式管理配置

如果需要将 Apache APISIX 配置作为代码管理,而不是逐个调用 Admin API,可以使用 ADC。ADC 读取描述网关期望状态的本地声明式文件,并在应用更改之前,将这些文件与运行中网关的配置进行比较。

该工作流可以帮助团队:

  • 通过版本控制审查和审计网关配置变更。
  • 在不同环境之间推广相同配置。
  • 在同步前预览资源的创建、更新和删除操作。
  • 导出现有网关配置,作为后续变更的基线。

ADC 适用于未运行在 Kubernetes 上的 APISIX 部署,也适用于通过 CI/CD 流水线管理网关配置的团队。

ADC 如何与 Apache APISIX 协同工作

ADC 通过 Admin API 连接 Apache APISIX,并将声明式配置应用到网关。团队可以使用文件管理路由、服务、上游、消费者、插件和其他网关资源,无需手动发送 API 请求。

应用更改之前,ADC 可以校验本地文件、请求后端验证资源,并显示本地期望状态与运行中网关之间的差异,使配置变更在到达 APISIX 前更易于审查。

有关 Apache APISIX 连接设置以外的详细信息,请参阅 ADC 文档