telicent/telicent-access-api

Telicent ACCESS演示应用API镜像文档

镜像概述

Telicent ACCESS演示应用API镜像（以下简称"API镜像"）是为Telicent ACCESS演示应用程序提供后端接口支持的Docker镜像。该镜像封装了演示应用所需的API服务，旨在简化演示环境部署流程，确保前端应用与后端服务的协同工作，是搭建完整演示环境的核心组件之一。

核心功能与特性

• RESTful API接口：提供标准化的RESTful接口，支持演示应用的核心业务逻辑交互
• 数据交互支持：实现演示应用所需的数据查询、提交及处理功能，确保前后端数据流转
• 轻量级部署：镜像体积优化，资源占用低，支持快速启动与部署
• 演示兼容性：与Telicent ACCESS演示前端应用无缝兼容，保证接口协议一致性
• 基础监控能力：内置健康检查接口，支持服务运行状态监控

使用场景与适用范围

• 演示环境搭建：用于构建Telicent ACCESS应用的完整演示环境，供展示或评估使用
• 功能验证：开发或测试人员通过部署该镜像验证演示应用的功能完整性
• 快速原型展示：在会议、展会等场景中快速部署，展示Telicent ACCESS应用的核心能力

注意：本镜像专为演示设计，未包含生产环境所需的安全加固、高可用配置及性能优化，严禁用于生产环境。

使用方法与配置说明

前提条件

• Docker Engine 20.10及以上版本
• （可选）Telicent ACCESS演示前端应用镜像（用于完整演示环境）

基本部署命令

bash
docker run -d \
  --name telicent-access-api \
  -p 8080:8080 \
  telicent/access-demo-api:latest

环境变量配置

Docker Compose配置示例

yaml
version: '3.8'
services:
  access-api:
    image: telicent/access-demo-api:latest
    container_name: telicent-access-api
    ports:
      - "8080:8080"
    environment:
      - PORT=8080
      - LOG_LEVEL=INFO
      - DEMO_DATA_MODE=true
      - CORS_ALLOWED_ORIGINS=http://localhost:3000
    restart: unless-stopped
    networks:
      - access-demo-network

networks:
  access-demo-network:
    driver: bridge

API访问验证

服务启动后，可通过以下方式验证API可用性：

bash
# 健康检查接口
curl http://localhost:8080/api/health

# 预期响应（服务正常）
{"status":"UP","timestamp":"2023-10-01T12:00:00Z"}

数据持久化说明

演示模式下（DEMO_DATA_MODE=true），所有数据为内存模拟数据，容器重启后数据将丢失。如需临时保留数据，可通过挂载卷实现：

bash
docker run -d \
  --name telicent-access-api \
  -p 8080:8080 \
  -v ./demo-data:/app/data \
  -e DEMO_DATA_MODE=false \
  telicent/access-demo-api:latest

注意事项

• 演示数据仅用于功能展示，不反映真实业务数据
• 高并发场景下可能出现性能下降，建议单实例演示用户不超过10人
• 如需自定义API行为，可通过挂载/app/config目录下的配置文件实现（具体配置项请参考镜像内/app/config/example.yaml）