washpost/pb-editor-api

PageBuilder Editor API Docker 镜像文档

一、镜像概述

PageBuilder Editor API 是一个用于页面构建器编辑器的后端服务镜像，提供了页面模板管理、组件配置和内容编辑的核心API功能。该镜像封装了完整的RESTful API服务，可快速集成到各类内容管理系统、网站构建平台或低代码开发环境中。

二、核心功能和特性

• 模板管理：支持创建、查询、更新和删除页面模板
• 组件库：提供丰富的UI组件元数据和配置接口
• 内容操作：完整的页面内容CRUD操作支持
• 版本控制：页面编辑历史记录和版本回溯功能
• 权限控制：基于角色的API访问权限管理
• 响应式设计：支持多设备适配的页面配置
• 数据验证：内置页面内容结构验证机制
• 扩展性：支持自定义组件和插件扩展

三、使用场景和适用范围

• 网站内容管理系统后端
• 营销页面构建平台
• 低代码/无代码开发环境
• 多租户SaaS应用的页面编辑模块
• 内部管理系统的界面定制工具
• 电商平台的页面装修功能

四、使用方法

4.1 快速启动

使用以下命令快速启动服务：

bash
docker run -d -p 8080:8080 --name pagebuilder-api pagebuilder/editor-api:latest

4.2 Docker Compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3.8'
services:
  pagebuilder-api:
    image: pagebuilder/editor-api:latest
    container_name: pagebuilder-api
    restart: always
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_NAME=pagebuilder
      - DB_USER=pbuser
      - DB_PASSWORD=pbpassword
      - JWT_SECRET=your_jwt_secret_key
      - LOG_LEVEL=INFO
    depends_on:
      - mysql
    networks:
      - pb-network

  mysql:
    image: mysql:8.0
    container_name: pagebuilder-mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=rootpassword
      - MYSQL_DATABASE=pagebuilder
      - MYSQL_USER=pbuser
      - MYSQL_PASSWORD=pbpassword
    volumes:
      - mysql-data:/var/lib/mysql
    networks:
      - pb-network

networks:
  pb-network:
    driver: bridge

volumes:
  mysql-data:

启动服务：

bash
docker-compose up -d

五、配置说明

5.1 环境变量

5.2 持久化数据

为保证数据持久化，建议挂载以下目录：

bash
docker run -d \
  -p 8080:8080 \
  -v /path/to/local/config:/app/config \
  -v /path/to/local/uploads:/app/uploads \
  --name pagebuilder-api \
  pagebuilder/editor-api:latest

六、API 访问

服务启动后，可通过以下地址访问API：

• 基础地址：http://localhost:8080/api/v1
• API文档：http://localhost:8080/swagger-ui.html
• 健康检查：http://localhost:8080/actuator/health

七、版本信息

八、维护和支持

• 镜像更新：docker pull pagebuilder/editor-api:latest
• 日志查看：docker logs -f pagebuilder-api
• 服务监控：通过 /actuator/metrics 端点获取性能指标
• 问题反馈：https://github.com/pagebuilder/editor-api/issues

九、注意事项

1. 生产环境中必须修改默认JWT密钥和数据库密码
2. 建议使用HTTPS加密传输敏感数据
3. 高并发场景下需配置适当的数据库连接池参数
4. 定期备份数据库数据以防止数据丢失
5. 升级前请查阅版本变更记录，注意兼容性问题