AsyncAPI Studio Docker镜像文档

镜像概述和主要用途

AsyncAPI Studio Docker镜像是一个基于***Nginx镜像的一站式工具，提供AsyncAPI文档的全生命周期管理功能。它允许用户在单一环境中完成文档开发、验证、版本转换、内容预览及事件流可视化，适用于各类容器化环境。

核心功能和特性

• 文档开发：提供AsyncAPI文档的编辑环境
• 有效性验证：实时验证文档格式及内容合法性
• 版本转换：支持将文档转换至最新AsyncAPI版本
• 文档预览：即时预览文档渲染效果
• 事件流可视化：图形化展示事件流结构
• Nginx扩展：基于***Nginx镜像，支持自定义Nginx配置和卷挂载

使用场景和适用范围

• 本地AsyncAPI文档开发与调试
• Docker Compose或Kubernetes等容器编排环境部署
• 需要非根路径访问的Web应用托管场景

使用方法和配置说明

基本使用

通过以下命令启动容器，访问http://localhost:8000即可使用：

bash
docker run -it -p 8000:80 asyncapi/studio

非根路径访问配置

在Docker Compose、Kubernetes等需要非根路径暴露容器的场景下，通过BASE_URL环境变量指定静态资源路径：

bash
docker run -it -p 8000:80 -e BASE_URL=/a/custom/path asyncapi/studio

高级配置

由于镜像基于Nginx镜像，可参考Nginx文档进行高级配置，例如：

• 挂载自定义Nginx配置文件
• 添加额外数据卷

Docker Desktop扩展

该镜像同时提供Docker Desktop扩展版本，更多信息请查看相关仓库。