castbuild/imagingservice-v3 Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

CAST IMAGING REST API 镜像文档

1. 镜像概述

CAST IMAGING REST API镜像封装了与CAST Imaging服务交互的编程接口，允许用户通过标准HTTP协议访问CAST Imaging的核心功能。该镜像提供了预配置的API服务环境，简化了与CAST Imaging服务的集成流程，适用于需要通过编程方式获取软件架构数据、执行分析操作或构建自定义集成方案的场景。

2. 核心功能与特性

2.1 核心功能

• 提供完整的RESTful API端点，支持与CAST Imaging服务的双向数据交互
• 支持获取软件架构可视化数据（如组件关系、依赖图谱、层级结构等）
• 允许查询软件分析结果（如技术债务、质量指标、合规性状态等）
• 支持执行基础操作（如刷新架构数据、导出报告等）

2.2 关键特性

• 兼容CAST Imaging最新版本，确保API功能同步更新
• 内置API文档（如Swagger/OpenAPI规范），便于接口调试与使用
• 支持多种认证方式（如API密钥、OAuth2等），保障接口访问安全
• 轻量级设计，启动快速且资源占用低
• 支持HTTPS加密传输，保护数据交互安全性

3. 使用场景与适用范围

3.1 主要使用场景

• 集成到CI/CD流程：在软件构建过程中自动调用API获取架构分析结果，实现质量门禁控制
• 自定义分析工具开发：基于API数据构建特定领域的软件架构分析工具
• 自动化报告生成：定期调用API获取数据并生成自定义格式的架构分析报告
• 第三方系统集成：与项目管理工具（如Jira）、监控平台（如Prometheus）或知识库系统集成，实现数据联动
• 教学与研究：获取软件架构数据用于学术研究或培训演示

3.2 适用用户

• 软件架构师与开发团队
• DevOps工程师（负责工具链集成）
• 质量保障（QA）团队
• 需要自定义软件架构分析流程的技术人员

4. 使用方法与配置说明

4.1 镜像拉取

bash
docker pull castsoftware/imaging-rest-api:latest

4.2 启动容器

基本启动命令：

bash
docker run -d \
  --name imaging-api \
  -p 8080:8080 \
  -e IMAGING_SERVICE_URL="[***]" \
  -e API_KEY="your-api-key" \
  castsoftware/imaging-rest-api:latest

4.3 环境变量配置

4.4 API使用示例

获取软件系统列表

bash
curl -X GET "http://localhost:8080/api/v1/systems" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"

获取特定系统的架构组件

bash
curl -X GET "http://localhost:8080/api/v1/systems/{system-id}/components" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Accept: application/json"

导出架构报告

bash
curl -X POST "http://localhost:8080/api/v1/systems/{system-id}/reports/export" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"format": "pdf", "sections": ["architecture", "dependencies", "quality"]}'

4.5 健康检查

容器启动后，可通过以下端点检查服务状态：

bash
curl http://localhost:8080/health

返回{"status": "UP"}表示服务正常运行。

5. 注意事项

• 确保IMAGING_SERVICE_URL指向的CAST Imaging服务已正常运行且版本兼容
• API密钥需具有足够权限（根据操作类型，可能需要"read"、"write"或"admin"权限）
• 生产环境建议启用SSL加密（设置SSL_ENABLED=true并挂载证书文件）
• 高并发场景下可通过调整容器资源限制（如--memory、--cpus）优化性能

6. API文档访问

容器启动后，可通过以下URL访问API文档（Swagger UI）：

http://localhost:8080/swagger-ui.html

文档中包含所有API端点的详细说明、请求参数及响应示例。