事件Catalog 的 AsyncAPI 生成器
特性: 以您的 AsyncAPI 文件生成事件Catalogs, 自动版本, 计划下载, 地图到域, 自定义 AsyncAPI 扩展等...
核心特征
- 来自您的 AsyncAPI 文件的文档域、 服务和信件 (% 1)实例(中文(简体) )
- * 视觉建筑(演示(中文(简体) )
- QQ 下载您的 AsyncAPI 文件及消息计划表 EventCatalog( 例如 Avro, JSON) (演示(中文(简体) )
- • 自定义 MDX 组件(更多信息(中文(简体) )
- QQ 自动版本您的域、 服务和信件
- ⭐ 记录您的频道和协议
- ⭐ 使用 EventCatalog 扩展名使用您的 AsyncAPI 文件文档查询、命令和事件
- * 发现特性(搜索、过滤等)(演示(中文(简体) )
- 还有更多...
如何运作
事件目录 技术是不可知论的,意思是它可以融入任何计划,规格或经纪人.
事件Catalog 支持 发电机。 。 。 . 生成器是运行到预建的脚本,以便在您的目录中生成内容 。 发电机可以使用 事件Catalog SDK。 。 。 .
使用此 AsyncAPI 插件, 您可以将您的 AsyncAPI 文件连接到您的目录 。 这是通过定义您的发电机在您的 eventcatlaog.config.js 文档.
...
generators: [
[
'@eventcatalog/generator-asyncapi',
{
services: [
{ path: path.join(__dirname, 'asyncapi-files', 'orders-service.asyncapi.yml'), id: 'Orders Service'},
{ path: path.join(__dirname, 'asyncapi-files', 'accounts-service.asyncapi.yml'), id: 'Accounts Service', name: 'Awesome Accounts Service')},
// Fetch AsyncAPI file from an external URL
{ path: "https://raw.githubusercontent.com/event-catalog/generator-asyncapi/refs/heads/main/src/test/asyncapi-files/simple.asyncapi.yml", id: 'Payment Service', name: 'Payment Service')}
],
domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
},
],
],
...
在此示例中,生成器将读取 orders-service.asyncapi.yml 文件并同时从外部 URL 获取 AsyncAPI 文件,并在您的目录中添加服务和信件。 它会把服务添加到域中 Orders。 。 。 .
你可以看到一个例子 事件catalog- ayncapi- 实例 还原
开始
安装和配置
请确定您在 EventCatalog 的最新版本中。 。 。 .
- 安装软件包
@eventcatalog/generator-asyncapi
-
配置您的
eventcatalog.config.js文件 (见实例) -
运行生成命令
npm run generate
- 参见您的新域、 服务和信件, 运行
npm run dev
代理服务器设置
配置环境变量 PROXY_SERVER_URI 要使用代理服务器.
您可以在下面以 URI 格式示例定义代理设置 :
您也可以将变量放入 .env 文档.
PROXY_SERVER_URI="http://username:[email protected]" npm run generate
有问题吗?
在这个项目上提出一个 GitHub 问题, 或者联系我们 我们的 Discord 服务器。 。 。 .
本地运行项目
- 清除还原
- 安装所需的依赖关系
pnpm i - 运行 “ npx tsx” 示例/ streelights- mqtt/ index.ts
- 运行测试
pnpm run tests
许可证
本项目根据以下规定获得许可证: MIT 许可证。 。 。 .