contful/openapi

Contful OpenAPI 镜像说明

镜像概述

Contful开源Headless CMS的开放API组件，负责从数据库读取内容数据，与contful/console管理控制台配合使用，支持PostgreSQL和达梦数据库两种版本，适用于容器化部署场景。

核心功能

1. 提供开放API接口，支持访问Contful CMS中的内容数据
2. 兼容PostgreSQL和达梦数据库
3. 无状态设计，可水平扩展以应对高并发需求
4. 支持环境变量（推荐）和配置文件两种配置模式
5. 内置健康检查机制，确保服务可用性

使用场景

1. 作为Headless CMS的内容访问层，为前端应用、移动应用、小程序等提供数据接口
2. 需要灵活内容模型和多站点管理的企业级应用
3. 基于容器编排系统（如K8s、Swarm）的分布式部署项目
4. 需要自定义内容访问逻辑的场景

配置说明

模式1：环境变量模式（推荐）

无需挂载配置文件，通过环境变量传递配置，适合容器编排系统。关键环境变量包括：

• DB_HOST：数据库地址
• DB_PORT：数据库端口
• DB_NAME：数据库名称
• DB_USER：数据库用户名
• DB_PASSWORD：数据库密码
• REDIS_HOST：Redis地址
• REDIS_PORT：Redis端口
• REDIS_PASSWORD：Redis密码
• 可选：SECRET（密钥）、CONTFUL_SERVER_PORT（服务端口）、LOG_LEVEL（日志级别）

模式2：配置文件模式

挂载自定义配置文件conf/openapi.yaml到容器内/app/config.yml，适合复杂自定义场景。

Docker部署示例

快速启动（环境变量模式）

1. 创建.env文件（复制示例并修改）：

bash
cp .env.example .env
# 编辑.env文件，填入DB_PASSWORD、REDIS_PASSWORD等参数

2. 使用docker-compose启动：

bash
docker-compose -f docker/docker-compose.yaml --env-file .env up -d

docker-compose配置片段

yaml
services:
  openapi:
    image: contful/openapi:pg-latest
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=contful
      - DB_USER=postgres
      - DB_PASSWORD=${DB_PASSWORD}
      - REDIS_HOST=redis
      - REDIS_PORT=6379
      - REDIS_PASSWORD=${REDIS_PASSWORD}
    volumes:
      - ./uploads:/app/uploads
      - ./logs:/app/logs
    healthcheck:
      test: ["CMD", "wget", "-q", "-O-", "http://localhost:8080/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 15s
    restart: unless-stopped
    ports:
      - "8080:8080"

访问与日志

• Open API地址：http://localhost:8080
• 日志查看：

bash
docker logs -f contful-openapi
docker exec contful-openapi cat /app/logs/access.log