altibase/document-access-rest

KADA: Altibase 文档访问 REST API

KADA (Key-optimized Altibase Document Access)

KADA是一个高性能RESTful API，允许在Altibase上进行MongoDB风格的文档管理。开发者无需复杂的schema设计即可直接在Altibase中存储、查询和管理JSON文档，充分利用Altibase强大的内存与磁盘混合架构。

核心功能

• 兼容MongoDB查询语法: 支持熟悉的MongoDB风格查询操作符（如$eq、$gt、$in、$and、$or等），便于开发者快速适应。
• 键优化性能: 针对基于键的查找和操作进行优化，为事务型工作负载提供卓越的速度。
• 灵活部署: 支持独立部署（JAR/WAR）和容器化部署（Docker/Kubernetes）。
• 双重认证支持（本地与OAuth2）: 灵活的安全模型，支持内置本地JWT认证和与外部身份提供商（如Keycloak、Auth0）的OAuth2资源服务器集成。
• 自动配置: 启动时自动创建必要的数据库用户和表（kada_db），简化初始设置流程。
• Swagger API文档: 通过Swagger UI提供交互式API文档，方便测试和集成。

快速开始（Docker）

您可以使用Docker快速运行Altibase文档访问REST API。

1. 前提条件

• Docker Engine 20.10+
• 运行中的Altibase数据库服务器（需要v8.1或更高版本）

2. 拉取镜像

bash
docker pull altibase/document-access-rest:latest

3. 运行容器

场景A：默认本地模式（内置JWT）

这是启动服务器的最简单方式，它连接到您的Altibase数据库并本地管理认证。

Bash（Linux / macOS）

bash
docker run -d \
  --name document-access-rest \
  -p 8080:8080 \
  -e KADA_ALTIBASE_HOST=host.docker.internal \
  -e KADA_ALTIBASE_PORT=20300 \
  -e KADA_ALTIBASE_DBNAME=mydb \
  -e KADA_ALTIBASE_SYS_PASSWORD=manager \
  -e KADA_API_ADMIN_PASSWORD=manager \
  -e KADA_API_USER_PASSWORD=manager \
  -e KADA_AUTO_SETUP_ENABLED=true \
  -e AUTH_PROVIDER=LOCAL \
  -e JWT_SECRET=change-this-secret-key \
  --add-host host.docker.internal:host-gateway \
  altibase/document-access-rest:latest

PowerShell（Windows）

powershell
docker run -d `
  --name document-access-rest `
  -p 8080:8080 `
  -e KADA_ALTIBASE_HOST=host.docker.internal `
  -e KADA_ALTIBASE_PORT=20300 `
  -e KADA_ALTIBASE_DBNAME=mydb `
  -e KADA_ALTIBASE_SYS_PASSWORD=manager `
  -e KADA_API_ADMIN_PASSWORD=manager `
  -e KADA_API_USER_PASSWORD=manager `
  -e KADA_AUTO_SETUP_ENABLED=true `
  -e AUTH_PROVIDER=LOCAL `
  -e JWT_SECRET=change-this-secret-key `
  --add-host host.docker.internal:host-gateway `
  altibase/document-access-rest:latest

场景B：身份提供商模式（外部认证）

如需与外部身份提供商（如Keycloak、Auth0）集成：

bash
docker run -d \
  --name document-access-rest \
  -p 8080:8080 \
  -e KADA_ALTIBASE_HOST=host.docker.internal \
  -e KADA_ALTIBASE_PORT=20300 \
  -e KADA_ALTIBASE_DBNAME=mydb \
  -e KADA_ALTIBASE_SYS_PASSWORD=manager \
  -e KADA_API_ADMIN_PASSWORD=manager \
  -e KADA_API_USER_PASSWORD=manager \
  -e KADA_AUTO_SETUP_ENABLED=true \
  -e AUTH_PROVIDER=IDP \
  -e IDP_ISSUER_URI=https://your-idp-domain.com/ \
  -e IDP_JWK_SET_URI=https://your-idp-domain.com/.well-known/jwks.json \
  --add-host host.docker.internal:host-gateway \
  altibase/document-access-rest:latest

注意: --add-host host.docker.internal:host-gateway 标志是容器访问主机上运行的服务（如本地Altibase数据库）所必需的。

文档

有关安装选项、配置和API使用的更多详细信息，请参考官方文档或服务器运行后的Swagger UI端点（/swagger-ui.html）。

注意: 出于安全考虑，Swagger UI和API文档默认是禁用的。要启用它们，必须在docker run命令中添加以下环境变量： -e SWAGGER_ENABLED=true -e API_DOCS_ENABLED=true