
apicurio/apicurio-studio-api启动apicurio/apicurio-studio-api:
docker run -it apicurio/apicurio-studio-api:latest-release
如需访问应用,可映射端口:
docker run -it -p 8080:8080 -p 8443:8443 apicurio/apicurio-studio-api:latest-release
启动该组件时,以下环境变量可用于配置(例如启动Docker镜像时设置):
| 环境变量名称 | 描述 | 默认值 |
|---|---|---|
| APICURIO_KC_AUTH_URL | Keycloak认证服务器的URL | [***] |
| APICURIO_KC_REALM | 用于认证的Keycloak领域名称 | apicurio |
| APICURIO_KC_CLIENT_ID | 用于认证的Keycloak客户端ID | apicurio-api |
| APICURIO_KC_SSL_REQUIRED | 用于确定是否必须通过HTTPS访问Keycloak服务器 | NONE |
| APICURIO_KC_DISABLE_TRUST_MANAGER | 设置为true可禁用访问Keycloak时的HTTP客户端信任管理器(用于对Keycloak进行HTTPS客户端调用时) | true |
| 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 | 设置为true时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_GITHUB_API_URL | GitHub API的URL | [***] |
| APICURIO_GITLAB_API_URL | GitLab API的URL | [***] |
| APICURIO_BITBUCKET_API_URL | Bitbucket API的URL | [***] |
例如,若希望使用自定义Keycloak客户端而保持其他设置为默认值,可按以下方式启动Docker镜像:
docker run -it -p 8080:8080 -p 8443:8443 \ -e "APICURIO_KC_AUTH_URL=[***]" \ -e "APICURIO_KC_REALM=my-apicurio" \ apicurio/apicurio-studio-api:latest-release
注意:通常需要至少自定义数据库设置,以便所有Apicurio组件(API、WS和UI)都指向同一个共享数据库实例(通常为mysql或postgresql)。
示例配置如下:
docker run -it -p 8080:8080 -p 8443:8443 \ -e "APICURIO_KC_AUTH_URL=[***]" \ -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-api:latest-release
apicurio/apicurio-studio-api组件只是构成Apicurio Studio应用程序的多个组件之一。要使Apicurio Studio完全正常运行,需要以下组件:
| 组件 | 描述 | Docker镜像 |
|---|---|---|
| API | 基于REST API的后端,UI的大部分操作都使用此组件 | apicurio/apicurio-studio-api |
| Editing | 基于WebSocket的并发编辑层,仅在UI编辑API时使用 | apicurio/apicurio-studio-ws |
| UI | 基于Angular的用户界面,用户通过此处访问Apicurio UI | apicurio/apicurio-studio-ui |
| Auth | 提供认证和账户链接功能的Keycloak服务器 | apicurio/apicurio-studio-auth |
注意:如果已拥有Keycloak服务器或不想使用apicurio/apicurio-studio-auth镜像,可自行安装/运行/配置Keycloak服务器。


manifest unknown 错误
TLS 证书验证失败
DNS 解析超时
410 错误:版本过低
402 错误:流量耗尽
身份认证失败错误
429 限流错误
凭证保存错误
来自真实用户的反馈,见证轩辕镜像的优质服务