Async API CLI生成HTML时如何包含引用的Schema与消息?
解决AsyncAPI CLI生成HTML时外部引用Schema/消息不显示的问题
- 先检查CLI版本:旧版(比如v2.0以下)对外部引用的支持有限,直接升级到最新稳定版,新版本在引用解析上做了优化。
- 生成HTML时添加
--resolve-external-refs参数,这个参数会让CLI强制解析所有外部引用的Schema和消息,生成的文档底部列表就会包含这些内容:asyncapi generate fromFile your-asyncapi.yaml -o output-dir -t @asyncapi/html-template --resolve-external-refs - 要是用配置文件管理引用,确保引用的相对路径是正确的,CLI得能正常读取到外部文件才能解析。
- 如果上面的方法不行,先把所有文档合并成一个再生成:用
bundle命令把外部引用的内容打包进主文档,再基于合并后的文件生成HTML:asyncapi bundle your-main-file.yaml -o bundled-file.yaml asyncapi generate fromFile bundled-file.yaml -o html-docs -t @asyncapi/html-template
内容的提问来源于stack exchange,提问作者Pieter
相关产品推荐
相关产品推荐

