事件Catalog 的 OpenAPI 生成器

特性: 以您的 OpenAPI 文件生成事件Catalogs, 自动版本, 计划下载, 地图到域, 自定义 OpenAPI 扩展等...

阅读文档 | 编辑文档 | 查看演示

核心特征

• QQ 文档域、 服务和您 OpenAPI 文件的信息 (实例(中文(简体) )
• * 视觉建筑(演示(中文(简体) )
• 从 EventCatalog 下载您的 OpenAPI 文件(演示(中文(简体) )
• • 自定义 MDX 组件(更多信息(中文(简体) )
• QQ 自动版本您的域、 服务和信件
• * 发现特性(搜索、过滤等)(演示(中文(简体) )
• 还有更多...

如何运作

事件目录 技术是不可知论的,意思是它可以融入任何计划,规格或经纪人.

事件Catalog 支持 发电机。 。 。 . 生成器是运行到预建的脚本,以便在您的目录中生成内容 。 发电机可以使用 事件Catalog SDK。 。 。 .

通过这个 OpenAPI 插件,您可以将您的 OpenAPI 文件连接到您的目录 。 这是通过定义您的发电机在您的 eventcatlaog.config.js 文档.

...
generators: [
    [
      '@eventcatalogtest/generator-openapi',
      {
        services: [
          { path: [path.join(__dirname, 'openapi-files', 'petstore.yml'), id: 'pet-store' },
          { path: [path.join(__dirname, 'openapi-files', 'account-service.yml'), id: 'account-service' },
        ],
        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
      },
    ],
  ],
...

在此示例中,生成器将读取 petstore.yml 在您的目录中存档并插入服务和信件。 它会把服务添加到域中 Orders。 。 。 .

你可以看到一个例子 事件catalog- openapi- 实例 还原

开始

安装和配置

请确定您在 EventCatalog 的最新版本中。 。 。 .

1. 安装软件包

@eventcatalog/generator-openapi

2. 配置您的 eventcatalog.config.js 文件 (见实例)

3. 运行生成命令

npm run generate

4. 参见您的新域、 服务和信件, 运行

npm run dev

有问题吗?

在这个项目上提出一个 GitHub 问题, 或者联系我们 我们的 Discord 服务器。 。 。 .

本地运行项目

1. 清除还原
2. 安装所需的依赖关系 pnpm i
3. 运行 “ npx tsx” 示例/ streelights- mqtt/ index.ts
4. 运行测试 pnpm run tests

许可证

本项目根据以下规定获得许可证: MIT 许可证。 。 。 .