stargateio/restapi

Stargate v2 REST API Docker镜像文档

镜像概述和主要用途

Stargate v2 REST API Docker镜像是开源数据API框架Stargate的组成部分，专为提供RESTful数据访问接口设计。Stargate作为部署在客户端应用与数据库之间的数据网关，以可扩展性为核心设计理念，支持通过插件扩展新API、数据类型及访问方法。

该镜像是Stargate v2项目的关键组件。Stargate v2正在将原协调器节点中的API服务重构为独立微服务，REST API是首个实现独立部署的微服务。此镜像需与Stargate v2协调器节点镜像配合使用，共同构成完整的Stargate v2数据网关架构。

核心功能和特性

• 独立微服务架构：基于Stargate v2设计，将REST API从协调器节点中解耦为独立服务，提升部署灵活性与可维护性。
• 可扩展性：原生支持插件机制，可扩展新API协议、数据类型及数据库访问方法，适配多样化应用需求。
• 兼容性：可与任意Stargate v2协调器节点镜像配合使用，构建完整数据网关。
• 开源与活跃开发：作为开源项目，持续迭代优化，社区支持活跃。

使用场景和适用范围

• 数据访问统一入口：为客户端应用提供标准化REST API接口，简化多类型数据库的访问逻辑。
• 微服务架构集成：作为独立微服务部署，适配云原生或微服务架构，支持横向扩展。
• 多API协议需求场景：需通过REST API访问数据库，或计划扩展其他API（如GraphQL、gRPC）的应用。
• 开发与测试环境：快速搭建数据网关原型，验证数据库访问逻辑。

使用方法和配置说明

前置条件

• 已安装Docker及Docker Compose（推荐用于多组件部署）。
• 需配合Stargate v2协调器节点镜像使用（如stargateio/stargate-coordinator-v2）。

部署方案示例

Docker Compose部署（推荐）

Stargate官方提供了完整的Docker Compose示例，可直接参考https://github.com/stargate/stargate/tree/main/docker-compose%E3%80%82%E4%BB%A5%E4%B8%8B%E4%B8%BA%E5%85%B8%E5%9E%8B%E9%83%A8%E7%BD%B2%E6%9E%B6%E6%9E%84%E7%A4%BA%E6%84%8F%EF%BC%88%E5%85%B7%E4%BD%93%E9%85%8D%E7%BD%AE%E9%9C%80%E5%8F%82%E8%80%83%E5%AE%98%E6%96%B9%E7%A4%BA%E4%BE%8B%EF%BC%89%EF%BC%9A

yaml
version: '3.8'
services:
  coordinator:
    image: stargateio/stargate-coordinator-v2:latest  # Stargate v2协调器节点
    environment:
      - CLUSTER_NAME=stargate-v2-cluster
      - SEED=coordinator  # 协调器节点标识
      - CASSANDRA_CONTACT_POINTS=cassandra  # 后端数据库地址（如Cassandra）
    ports:
      - "7000:7000"  # 内部通信端口
    depends_on:
      - cassandra  # 假设后端使用Cassandra数据库

  rest-api:
    image: stargateio/stargate-rest-api-v2:latest  # 当前REST API镜像
    environment:
      - COORDINATOR_HOST=coordinator  # 协调器节点主机名
      - COORDINATOR_PORT=7000  # 协调器节点通信端口
    ports:
      - "8082:8082"  # REST API服务端口
    depends_on:
      - coordinator

  cassandra:  # 示例后端数据库
    image: cassandra:4.0
    ports:
      - "9042:9042"

Docker Run部署

单节点快速启动（需先启动协调器节点）：

bash
# 假设协调器节点已启动，主机名为coordinator，通信端口7000
docker run -d \
  --name stargate-rest-api \
  -e COORDINATOR_HOST=coordinator \
  -e COORDINATOR_PORT=7000 \
  -p 8082:8082 \
  stargateio/stargate-rest-api-v2:latest

配置说明

该镜像的核心配置通过环境变量实现，主要包括：

注：完整配置参数及高级用法请参考Stargate官方文档及https://github.com/stargate/stargate%E3%80%82

参考资源

• 官方文档：stargate.io
• 社区参与：Stargate社区页面
• Docker Compose示例：https://github.com/stargate/stargate/tree/main/docker-compose
• Stargate v2项目背景：项目公告
• GitHub资源：https://github.com/stargate/stargate/labels/stargate-v2%E3%80%81https://github.com/stargate/stargate/discussions?discussions_q=label%3Astargate-v2