blendededge/rest-api-component-oih

Open Integration Hub REST API 组件镜像

镜像概述

本镜像为Open Integration Hub（开放集成中心）的核心组件之一，专注于提供标准化的RESTful API接口，用于实现不同系统、服务或平台间的集成与数据交换。通过该组件，用户可便捷地管理集成流程、对接外部服务，并实现跨系统的数据同步与业务流程自动化。

核心功能与特性

• RESTful API接口支持：遵循REST规范设计API，支持GET、POST、PUT、DELETE等标准HTTP方法，提供清晰的资源路径与状态码。
• 集成流程管理：支持集成流程的创建、查询、更新与删除，提供流程状态监控与日志记录功能。
• 数据转换与映射：内置基础数据转换能力，支持不同数据格式（如JSON、XML）间的转换与字段映射。
• 服务对接适配：提供标准化接口适配层，支持对接各类外部服务（如CRM、ERP、云服务等）。
• 可扩展性：支持插件机制，可通过扩展模块增强API功能（如认证授权、流量控制、数据校验等）。
• 高可用性：支持集群部署，通过负载均衡提升服务稳定性与并发处理能力。

使用场景

• 企业系统集成：对接企业内部ERP、CRM、HRM等系统，实现数据互通与业务流程联动。
• 跨平台数据交换：在云服务、本地系统、第三方应用间建立数据通道，支持实时/定时数据同步。
• 微服务架构API网关：作为微服务架构中的API入口，统一接口规范并管理服务间调用。
• 自动化工作流集成：与自动化工具（如Jenkins、GitLab CI）联动，实现集成流程的自动化触发与执行。

使用方法与配置说明

基本使用（Docker Run）

通过以下命令快速启动容器：

bash
docker run -d \
  --name oih-rest-api \
  -p 3000:3000 \
  -e API_PORT=3000 \
  -e LOG_LEVEL=info \
  -e DATABASE_URL=postgresql://user:password@db-host:5432/oih_db \
  openintegrationhub/rest-api:latest

环境变量配置

容器运行时可通过环境变量调整配置，常用参数如下：

Docker Compose配置示例

以下为docker-compose.yml示例，集成数据库与API组件：

yaml
version: '3'
services:
  rest-api:
    image: openintegrationhub/rest-api:latest
    ports:
      - "3000:3000"
    environment:
      - API_PORT=3000
      - LOG_LEVEL=info
      - DATABASE_URL=postgresql://postgres:postgres@db:5432/oih_db
      - AUTH_ENABLED=true
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:14
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=oih_db
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

持久化存储

若需持久化API配置或日志数据，可通过挂载宿主机目录实现：

bash
docker run -d \
  --name oih-rest-api \
  -p 3000:3000 \
  -e DATABASE_URL=postgresql://user:password@db-host:5432/oih_db \
  -v /path/to/local/config:/app/config \
  -v /path/to/local/logs:/app/logs \
  openintegrationhub/rest-api:latest

注意事项

• 生产环境中需启用AUTH_ENABLED并配置安全的认证机制（如JWT、OAuth2）。
• 数据库连接需确保网络可达，建议使用容器网络或内部服务名（如Docker Compose中的db）。
• 高并发场景下建议调整MAX_PAYLOAD_SIZE并配置负载均衡（如Nginx、Kubernetes Service）。