koxudaxi/local-data-api

local-data-api - 本地AWS Aurora Serverless Data API代理

镜像概述和主要用途

local-data-api是一个本地Data API代理服务器，用于模拟AWS Aurora Serverless的Data API。它作为真实数据库的"代理服务器"，将RESTful请求转换为SQL语句，使开发者能够在本地机器和CI环境中使用MySQL和PostgreSQL服务器进行测试，无需依赖AWS云环境。

核心功能和特性

• 数据库支持：兼容MySQL和PostgreSQL数据库
• API转换：将RESTful请求转换为SQL语句执行
• AWS兼容性：模拟AWS Aurora Serverless Data API接口，可与AWS客户端（如aws-cli、boto3）无缝集成
• 本地测试：支持在本地开发环境和CI流程中进行数据库应用测试

使用场景和适用范围

• 本地开发环境中测试依赖AWS Data API的应用
• CI/CD流程中自动化测试数据库相关功能
• 无需实际AWS Aurora Serverless集群即可验证Data API调用逻辑
• 开发基于AWS Data API的应用程序时进行本地调试

使用方法和配置说明

基本使用（Docker Run）

通过环境变量配置数据库连接信息，启动local-data-api容器：

bash
docker run --rm -it --name my-data-api -p 8080:80  \
  -e MYSQL_HOST=<您的MySQL主机> \
  -e MYSQL_PORT=<您的MySQL端口> \
  -e MYSQL_USER=<您的MySQL用户名> \
  -e MYSQL_PASSWORD=<您的MySQL密码> \
  -e RESOURCE_ARN=arn:aws:rds:us-east-1:123456789012:cluster:dummy \
  -e SECRET_ARN=arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy  \
  koxudaxi/local-data-api

启动后，可通过AWS客户端指定本地端点访问：

bash
aws --endpoint-url http://127.0.0.1:8080 rds-data execute-statement \
  --resource-arn "arn:aws:rds:us-east-1:123456789012:cluster:dummy" \
  --sql "show databases"  \
  --secret-arn "arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy" \
  --database 'test'

Docker Compose配置

MySQL配置（docker-compose-mysql.yml）

yaml
version: '3.1'

services:
  local-data-api:
    image: koxudaxi/local-data-api
    restart: always
    environment:
      MYSQL_HOST: db
      MYSQL_PORT: 3306
      MYSQL_USER: root
      MYSQL_PASSWORD: example
      RESOURCE_ARN: 'arn:aws:rds:us-east-1:123456789012:cluster:dummy'
      SECRET_ARN: 'arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy'
    ports:
      - "8080:80"
  db:
    image: mysql:5.6
    command: --default-authentication-plugin=mysql_native_password
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: example
      MYSQL_DATABASE: test
    ports:
        - "3306:3306"

PostgreSQL配置（docker-compose-postgres.yml）

yaml
version: '3.1'

services:
  local-data-api:
    image: koxudaxi/local-data-api
    restart: always
    environment:
      ENGINE: PostgreSQLJDBC
      POSTGRES_HOST: db
      POSTGRES_PORT: 5432
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: example
      RESOURCE_ARN: 'arn:aws:rds:us-east-1:123456789012:cluster:dummy'
      SECRET_ARN: 'arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy'
    ports:
      - "8080:80"
  db:
    image: postgres:10.7-alpine
    restart: always
    environment:
      POSTGRES_PASSWORD: example
      POSTGRES_DB: test
    ports:
        - "5432:5432"

与Python AWS SDK (boto3) 配合使用

1. 启动容器：

bash
docker-compose up -d

2. 在代码中配置本地端点：

python
import boto3
client = boto3.client(
    'rds-data', 
    endpoint_url='http://127.0.0.1:8080', 
    aws_access_key_id='aaa',  
    aws_secret_access_key='bbb'
)

3. 执行SQL语句：

python
# 显示数据库
client.execute_statement(
    resourceArn='arn:aws:rds:us-east-1:123456789012:cluster:dummy',
    secretArn='arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy',
    sql='show databases',
    database='test'
)

# 查询表数据
client.execute_statement(
    resourceArn='arn:aws:rds:us-east-1:123456789012:cluster:dummy',
    secretArn='arn:aws:secretsmanager:us-east-1:123456789012:secret:dummy',
    sql='select * from users',
    database='test'
)

环境变量说明

通用环境变量

• RESOURCE_ARN: AWS资源ARN（可使用虚拟ARN，如示例中的dummy值）
• SECRET_ARN: AWS密钥ARN（可使用虚拟ARN，如示例中的dummy值）
• ENGINE: 数据库引擎类型（MySQLJDBC或PostgreSQLJDBC，默认MySQLJDBC）

MySQL专用环境变量

• MYSQL_HOST: MySQL服务器主机地址
• MYSQL_PORT: MySQL服务器端口（默认3306）
• MYSQL_USER: MySQL用户名
• MYSQL_PASSWORD: MySQL密码

PostgreSQL专用环境变量

• POSTGRES_HOST: PostgreSQL服务器主机地址
• POSTGRES_PORT: PostgreSQL服务器端口（默认5432）
• POSTGRES_USER: PostgreSQL用户名
• POSTGRES_PASSWORD: PostgreSQL密码

相关项目

• py-data-api: Python的DataAPI客户端
  https://github.com/koxudaxi/py-data-api

相关链接

• Docker镜像: https://hub.docker.com/r/koxudaxi/local-data-api
• 源代码: https://github.com/koxudaxi/local-data-api
• 文档: https://koxudaxi.github.io/local-data-api

许可证

local-data-api采用MIT许可证发布。[***]