creatiwity/siren

Siren API Docker镜像文档

镜像概述和主要用途

Siren API Docker镜像旨在提供便捷的API服务，用于访问法国国家统计与经济研究所（INSEE）发布的v3版本数据。该镜像封装了必要的服务组件，可快速部署并提供标准化的数据查询接口，适用于需要集成INSEE数据的应用开发与数据分析场景。

核心功能和特性

• INSEE v3数据支持：完整兼容INSEE v3数据格式与接口规范，提供标准化数据访问能力
• RESTful API接口：遵循REST设计原则，支持HTTP请求方法（GET、POST等），便于客户端集成
• 轻量级部署：基于精简基础镜像构建，资源占用低，支持快速启动与扩展
• 可配置参数：支持通过环境变量自定义服务端口、缓存策略等关键配置
• 数据缓存机制：内置数据缓存功能，提升高频查询场景下的响应速度

使用场景和适用范围

• ***与公共政策分析：集成INSEE经济、人口统计数据，支持政策研究与决策支持
• 学术研究：为经济学、社会学等领域的学术研究提供标准化数据接口
• 商业智能应用：辅助企业基于INSEE宏观经济数据进行市场分析与战略规划
• 开发者集成：供开发者快速将INSEE数据集成到Web应用、移动应用或数据可视化平台

使用方法和配置说明

基本部署（docker run）

通过以下命令快速启动Siren API服务：

bash
docker run -d -p 8080:8080 --name siren-api siren-api:latest

环境变量配置

支持通过环境变量自定义服务行为，常用配置参数如下：

示例（自定义端口与缓存时间）：

bash
docker run -d \
  -p 9000:9000 \
  -e PORT=9000 \
  -e CACHE_TTL=120 \
  --name siren-api-custom \
  siren-api:latest

docker-compose配置

创建docker-compose.yml文件进行多容器协同部署：

yaml
version: '3'
services:
  siren-api:
    image: siren-api:latest
    ports:
      - "8080:8080"
    environment:
      - PORT=8080
      - CACHE_TTL=60
      - LOG_LEVEL=INFO
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

验证服务可用性

服务启动后，可通过以下命令验证API是否正常运行：

bash
curl http://localhost:8080/health

若返回状态码200 OK，表示服务部署成功。