apicurio/apicurio-studio-ws
apicurio
Apicurio Studio应用程序的WebSocket组件，提供基于WebSocket的并发编辑层，用于API编辑时的实时协作功能。
2 次收藏下载次数: 0状态：社区镜像维护者：apicurio仓库类型：镜像最近更新：2 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
Apicurio WS 组件
概述
Apicurio WS 组件是 Apicurio Studio 应用程序的重要组成部分，主要提供基于 WebSocket 的并发编辑层，仅在用户编辑 API 时由 UI 组件调用，支持实时协作编辑功能。
使用方法
基础运行
启动 Apicurio WS 组件的基础命令：
bashdocker run -it apicurio/apicurio-studio-ws:latest-release
端口映射
若需外部访问应用，需映射端口：
bashdocker run -it -p 8080:8080 -p 8443:8443 apicurio/apicurio-studio-ws:latest-release
镜像配置
启动该组件时，可通过以下环境变量进行配置：
| 环境变量名称 | 描述 | 默认值 |
|---|---|---|
| APICURIO_PORT_OFFSET | 服务器启动时使用的端口偏移量（例如，设为10可将HTTP端口从8080移至8090） | 0 |
| APICURIO_DB_DRIVER_NAME | 数据库驱动名称，可选值：h2、mysql、postgresql | h2 |
| APICURIO_DB_CONNECTION_URL | 数据库（JDBC）连接URL | jdbc:h2:mem:apicuriodb |
| APICURIO_DB_USER_NAME | 数据库用户名 | sa |
| APICURIO_DB_PASSWORD | 数据库密码 | sa |
| APICURIO_DB_INITIALIZE | 是否由Apicurio初始化数据库（若DBA手动初始化则设为false） | true |
| APICURIO_DB_TYPE | 数据库类型，有效值：h2、postgresql9、mysql5 | h2 |
| APICURIO_LOGGING_LEVEL | 默认日志级别 | INFO |
| APICURIO_MIN_HEAP | Java堆内存最小值 | 768m |
| APICURIO_MAX_HEAP | Java堆内存最大值 | 2048m |
配置示例
通常需要自定义数据库设置，确保所有 Apicurio 组件（API、WS、UI）指向同一共享数据库实例（通常为 MySQL 或 PostgreSQL）。示例配置：
bashdocker run -it -p 8080:8080 -p 8443:8443 \ -e "APICURIO_KC_AUTH_URL=https://keycloak.example.com/auth/" \ -e "APICURIO_DB_DRIVER_NAME=postgresql" \ -e "APICURIO_DB_CONNECTION_URL=jdbc:postgresql://db.example.com:5432/apicuriodb" \ -e "APICURIO_DB_TYPE=postgresql9" \ -e "APICURIO_DB_USER_NAME=dbuser" \ -e "APICURIO_DB_PASSWORD=dbpassword123" \ apicurio/apicurio-studio-ws:latest-release
组件要求
apicurio/apicurio-studio-ws 仅是 Apicurio Studio 应用程序的组件之一。要使 Apicurio Studio 完全正常运行，需部署以下组件：
| 组件 | 描述 | Docker 镜像 |
|---|---|---|
| API | 基于 REST API 的后端，UI 用于大多数操作 | apicurio/apicurio-studio-api |
| Editing | 基于 WebSocket 的并发编辑层，仅在编辑 API 时由 UI 使用 | apicurio/apicurio-studio-ws |
| UI | 基于 Angular 的用户界面，用户通过此处访问 Apicurio | apicurio/apicurio-studio-ui |
| Auth | 提供身份验证和账户链接功能的 Keycloak 服务器 | apicurio/apicurio-studio-auth |
注意：如果已有 Keycloak 服务器或不想使用
apicurio/apicurio-studio-auth镜像，可自行安装/运行/配置 Keycloak 服务器。
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 apicurio-studio-ws 镜像标签
docker pull docker.xuanyuan.run/apicurio/apicurio-studio-ws:<标签>
DockerHub 原生拉取命令
docker pull apicurio/apicurio-studio-ws:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"