AsyncAPI 生成器的下沉模板
使用量
安装 AsyncAPI CPI
npm install -g @asyncapi/cli
使用 CLI 生成
asyncapi generate fromTemplate <asyncapi.yaml> @asyncapi/[email protected]
您可以替换 <asyncapi.yaml> 本地路径或 URL 指向 任意 AsyncAPI 文档。 。 。 .
调查 释放 的模板,以获取所需的版本。 不建议在生产中总是使用最新产品。 总是使用特定版本.
支持参数
| 名称 | 说明 | 需求 | 默认 | 允许的值 | 示例 |
|---|---|---|---|---|---|
| 前置马特 | JSON 或 YAML 格式化文件的名称, 包含为静态站点或文档生成器提供 YAML 前题的值, 就像 这个 一个 文件可能包含 QQtitle 和 QQversion 标签 。 它们被以下AsyncAPI文件的信息所取代: info.title 财务报告和审定财务报表 info.version。您可以覆盖该版本 version 参数. 给 您可以看到一个实例,该实例在前题中使用与 列表 | 没有 | 无 | JSON 或 YAML 格式化文件 | slate.yaml |
| 外页名 | 输出文件的文件名 . | 没有 | asyncapi.md | 任意 与 .md 扩展 | index.md |
| 目标c | 在产出减值中包含一个内容表. | 没有 | true | boolean | false |
| 版本 | 覆盖您的应用程序版本 info.version 指定文件中的位置. | 没有 | 版本取自规格文件. | 版本取自 spec 文件 . | 1.0.0 |
发展
开发模板的最佳和最可靠的方法是在CLI中使用Genera的构建. 克隆发电机跟随官方 发展指南。 。 。 .
贡献者
感谢这些伟大的人emoji 密钥:
 弗朗·门德斯 💻 📖 👀 🤔 🚧 🐛 ⚠️ |
 卢卡斯·戈尔尼茨基 💻 📖 👀 🚇 🚧 🐛 ⚠️ |
 伊利亚·布斯洛夫 💻 🐛 |
 朱利安·拉贝 💻 |
 马西杰·乌尔班奇克 📖 💻 🚧 🐛 👀 ⚠️ |
 卢多维奇·杜萨尔 💻 |
 迈克·拉尔夫森 💻 |
 断层无穷 🐛 💻 |
 戴尔·莱恩 💻 🤔 |
 迈克尔·格里舍 💻 🐛 ⚠️ |
 阿里亚·古普塔 📖 |
 基里尔·埃菲莫夫 💻 ⚠️ |
本项目遵循 全部贡献者 规格。 任何捐款都欢迎!