agaveapi/changelog-parser

Changelog Parser 微服务镜像

镜像概述

本镜像基于kern046/changelog-parser库构建，提供轻量级微服务接口，用于从远程URL读取变更日志文件，解析为结构化JSON数据并返回，支持缓存管理以优化性能。

核心功能

1. 跨源解析：支持从任意合法远程URL获取变更日志文件
2. 结构化输出：将Markdown格式的变更日志转换为易于处理的JSON格式
3. 缓存控制：默认缓存有效期1小时，可自定义调整缓存时间
4. API服务：通过HTTP接口提供解析能力，支持参数控制结果范围（如仅返回最新版本）

使用场景

• 应用前端动态展示版本更新记录
• 自动化工具集成软件版本变更信息
• 第三方服务获取开源项目的更新日志

配置说明

缓存调整

通过代码修改缓存有效期（单位：秒）：

php
use ChangelogParser\Manager\ChangelogManager;
$manager = new ChangelogManager();
$cache = $manager->getCacheManager();
// 设置缓存有效期为1天（86400秒）
$cache->setCacheTime(86400);

API参数说明

API接口支持以下查询参数：

Docker部署示例

使用Docker Compose快速启动服务：

yaml
version: '3'
services:
  changelog-parser:
    image: agaveapi/changelog-parser
    ports:
      - "8888:80"
    restart: unless-stopped

执行部署命令：

shell
docker-compose up -d

服务启动后，可通过http://<Docker主机IP>:8888访问API接口。