4xxi/caesarapp-server

CaesarApp Server

镜像概述

CaesarApp Server是CaesarApp应用的后端API服务器，负责处理加密消息的存储与管理，支持消息的创建、获取及自动销毁功能，适用于临时敏感信息的安全传递场景。

核心功能

• 加密消息存储：将消息内容加密后存储于Redis数据库
• 过期时间限制：可设置消息存活时长，超时后自动永久销毁
• 访问次数限制：可设置消息最大访问次数，达到次数后自动销毁
• API状态检查：提供接口查询服务运行状态

使用场景

• 临时敏感信息分享（如一次性密码、临时链接）
• 需自动销毁的保密通信
• 测试环境下的消息管理接口部署

配置说明

应用配置存储于.env文件，主要配置项：

1. HTTP端口：通过SERVER_HTTP_PORT设置服务端口，避免与主机端口冲突
2. 应用环境：通过APP_ENV设置dev（开发）或prod（生产）环境
3. Redis配置：通过REDIS_URL设置Redis连接信息，修改后需重启容器

Docker部署示例

依赖要求

• Docker及Docker Compose（需提前安装）
• MacOS额外需要Docker Sync（执行gem install docker-sync安装）

部署步骤

1. 启动容器并安装依赖 Linux系统：

bash
docker-compose -f docker-compose-dev.yml up -d

MacOS系统：

bash
docker-sync-stack start

2. 访问服务：打开http://localhost即可访问

API文档

Message Entity

消息存储于Redis，包含以下字段：

• id：消息唯一标识（自动生成）
• message：加密后的消息内容（含附件）
• requestsLimit：消息最大访问次数
• secondsLimit：消息存活时长（秒）
• expires：消息销毁时间（RFC格式）

API调用

Base URL

所有接口前缀为/api，基础URL为yourdomain.org/api

错误格式

错误响应状态码为400（POST请求）或404（GET请求），返回格式示例：

json
{
    "errors": {
        "secondsLimit": ["值不能为空", "值不能大于5"],
        "requestsLimit": ["值不能为空"]
    }
}

POST /messages

创建新消息，请求需为JSON格式： 输入参数：message（必填）、requestsLimit（必填）、secondsLimit（必填）
请求示例：

json
{
    "message":"text",
    "secondsLimit":10,
    "requestsLimit":5
}

响应示例：

json
{
    "id":"745e8728047f7c7970d13d47b2ffb737faa3c9b7",
    "message":"text",
    "expires":"2018-05-12T21:21:48+00:00",
    "requestsLimit":2,
    "secondsLimit":100
}

GET /messages/{id}

获取指定ID的消息
响应示例：

json
{
    "id":"745e8728047f7c7970d13d47b2ffb737faa3c9b7",
    "message":"text",
    "expires":"2018-05-12T21:21:48+00:00",
    "requestsLimit":2,
    "secondsLimit":100
}

错误响应（404）：

json
{
    "errors": {"id":"消息未找到"}
}

GET /messages

查询API状态
响应示例：

json
{
    "status":"OK"
}

其他说明

• requestsLimit在响应中不会更新（出于安全考虑，用户无法查看剩余访问次数）
• 每次成功访问GET /messages/{id}会减少1次访问次数，次数为0时消息销毁

开发笔记

代码风格检查与测试

• 修复代码风格：

bash
docker-compose exec php vendor/bin/php-cs-fixer fix

• 运行PHPUnit测试：

bash
docker-compose exec php bin/phpunit