asyncapi/generator

AsyncAPI Generator 镜像文档

镜像概述和主要用途

AsyncAPI Generator 是一款基于 AsyncAPI 规范文件生成各类内容的工具。它以 AsyncAPI 规范作为输入，可生成应用程序代码、API 文档等多种输出，帮助开发者快速实现基于 AsyncAPI 规范的服务开发与文档管理。

核心功能和特性

• 多语言代码生成：支持生成 Node.js、Java、Python、TypeScript、Go、.NET、PHP 等多种语言的服务端/客户端代码。
• 多协议支持：覆盖 WebSockets、JMS、Spring Cloud Stream、NATS、RabbitMQ 等多种通信协议。
• 文档生成能力：可生成 HTML 文档网站、Markdown 文档等格式的 API 文档。
• 丰富官方模板：提供大量官方维护的模板，满足不同场景需求（如 Spring 服务、WebSockets 服务等）。
• 社区模板扩展：支持使用社区贡献的模板，扩展生成能力。

使用场景和适用范围

适用场景

• API 文档自动化：根据 AsyncAPI 规范自动生成 HTML/Markdown 格式的 API 文档。
• 客户端/服务端代码生成：针对不同语言（Java、Node.js、Python 等）和协议（如 NATS、RabbitMQ）生成基础代码，减少手动编码工作量。
• 标准化开发流程：统一基于 AsyncAPI 规范的代码生成流程，提升团队协作效率。

适用范围

• 需要基于 AsyncAPI 规范进行 API 设计与开发的团队或个人。
• 后端服务开发者、API 文档编写者、DevOps 工程师等。

官方模板列表

官方模板及社区模板可在 https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate 中查看。

使用方法和配置说明

Docker CLI 基本用法

通过 docker run 命令运行镜像，需挂载本地 AsyncAPI 规范文件和输出目录，指定目标模板。

命令示例（生成 HTML 文档）

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/asyncapi/generator /app/asyncapi.yaml -o /app/output @asyncapi/html-template

参数说明

• --rm：容器运行结束后自动删除。
• -v $(pwd):/app：将当前目录挂载到容器内的 /app 目录，用于输入 AsyncAPI 文件和输出结果。
• /app/asyncapi.yaml：容器内的 AsyncAPI 规范文件路径（需确保本地当前目录存在此文件）。
• -o /app/output：指定输出目录（容器内路径，对应本地挂载目录下的 output 文件夹）。
• @asyncapi/html-template：指定使用的模板名称（此处为生成 HTML 文档的官方模板）。

生成其他类型内容示例

生成 Node.js WebSockets 服务

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/asyncapi/generator /app/asyncapi.yaml -o /app/nodejs-ws-service @asyncapi/nodejs-ws-template

生成 Java Spring 服务

bash
docker run --rm -v $(pwd):/app docker.xuanyuan.run/asyncapi/generator /app/asyncapi.yaml -o /app/java-spring-service @asyncapi/java-spring-template

常用配置参数

参考文档

详细使用方法及更多配置选项，请参见 AsyncAPI Generator 官方文档。