AsyncAPI CLI 镜像文档

概述和主要用途

AsyncAPI CLI 是一个用于处理 AsyncAPI 文件的命令行工具，目前处于开发阶段，团队正在持续添加更多功能。该工具可帮助开发者验证、管理 AsyncAPI 规范文件，并支持集成到 CI/CD 流程中，提供便捷的 API 规范处理能力。

核心功能和特性

• AsyncAPI 文件处理：支持对 AsyncAPI 规范文件进行验证、配置管理等基础操作
• 多环境集成：可作为 GitHub Action 集成到 GitHub 工作流中，实现自动化流程
• 模块化架构：采用可扩展的架构设计，便于功能扩展和维护
• 标准化 CLI 体验：遵循 Command Line Interface Guideline 设计规范

使用场景和适用范围

• API 开发：验证 AsyncAPI 规范文件的语法和结构正确性
• 文档管理：辅助生成和维护基于 AsyncAPI 规范的 API 文档
• CI/CD 流程：通过 GitHub Action 在代码提交或构建阶段自动验证 API 规范
• 本地开发：在开发环境中快速操作和测试 AsyncAPI 文件

安装和使用方法

安装

通过 Docker 拉取 AsyncAPI CLI 镜像：

docker pull asyncapi/cli

基本使用

验证 AsyncAPI 文件

将本地 AsyncAPI 文件挂载到容器中进行验证：

docker run --rm -v $(pwd):/workspace asyncapi/cli validate /workspace/your-asyncapi-file.yaml

查看帮助信息

获取 CLI 命令列表和使用说明：

docker run --rm asyncapi/cli --help

配置上下文管理

添加和管理 AsyncAPI 文件上下文：

docker run --rm -v $(pwd):/workspace asyncapi/cli config context add my-context /workspace/your-asyncapi-file.yaml

作为 GitHub Action 使用

在 GitHub Actions 工作流中集成 CLI 进行自动化验证：

jobs:
  validate-asyncapi:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Validate AsyncAPI spec
        uses: asyncapi/cli-action@v1
        with:
          command: validate your-asyncapi-file.yaml

架构

AsyncAPI CLI 采用模块化架构设计，详细架构说明可参考 架构指南。

贡献指南

设置开发环境

1. 克隆仓库：git clone [***]
2. 安装依赖：npm install
3. 运行测试：npm run test
4. 构建并本地运行：npm run build && bin/run

命令结构和模式

遵循以下命令设计模式：

• 动词+名词：如 asyncapi validate <spec-file-path>（验证规范文件）
• 命名空间+名词+[动词]：如 asyncapi config context add <context-name> <spec-file-path>（添加配置上下文）

许可证和贡献者

该项目采用 Apache 许可证，感谢所有 贡献者 的支持。