架构即代码 - Archyl Docs

使用 archyl.yaml 定义和同步 C4 架构 — 版本控制、CI/CD 就绪、完全声明式

导出

Archyl 允许您将架构图导出为多种格式,用于演示文稿、文档和外部工具。

可用格式

PNG(位图图像)

适用于:

  • 演示文稿(PowerPoint、Google Slides)
  • 文档(Word、Google Docs)
  • 聊天和邮件分享
  • 社交媒体发布

PNG 导出保持完整的视觉质量,分辨率可自定义。

SVG(矢量图形)

适用于:

  • 设计工具(Figma、Sketch、Illustrator)
  • 高分辨率打印
  • 网页嵌入
  • 进一步编辑

SVG 导出可缩放到任意大小而不损失质量。

PDF(文档格式)

适用于:

  • 打印
  • 正式文档
  • 存档目的
  • 多页导出

PDF 导出包含所有样式,可跨多页。

如何导出

单层导出

  1. 导航到要导出的 C4 层次
  2. 点击工具栏中的 导出
  3. 选择格式(PNG、SVG 或 PDF)
  4. 配置选项
  5. 点击 导出

导出所有层次

一次导出所有四个 C4 层次:

  1. 点击工具栏中的 导出
  2. 选择格式
  3. 勾选 导出所有层次
  4. 点击 导出

这将为每个层次生成单独的文件:

  • project-name-system-context.png
  • project-name-container.png
  • project-name-component.png
  • project-name-code.png

导出选项

背景选项

选项 描述
包含背景 使用深色画布背景导出
透明 无背景导出(适应任何文档)

对于浅色主题的文档,透明导出效果最佳。

质量设置

PNG 导出:

  • 标准:适合屏幕查看
  • :适合演示文稿
  • 印刷:适合物理打印

视口选项

  • 适应内容:仅导出图表内容
  • 包含边距:在图表周围添加边距
  • 当前视图:导出屏幕上可见的内容

获得最佳效果的技巧

用于演示文稿

  1. 以高质量导出 PNG
  2. 深色幻灯片包含背景
  3. 浅色幻灯片使用透明
  4. 根据受众导出适当的 C4 层次

用于文档

  1. 导出 SVG 以便缩放
  2. 使用透明背景
  3. 考虑导出所有层次
  4. 将导出文件添加到文档仓库

用于打印

  1. 导出 PDF
  2. 选择高分辨率
  3. 包含背景以增强视觉效果
  4. 打印前查看打印预览

用于设计工具

  1. 导出 SVG
  2. 导入到设计工具中
  3. 元素保持可编辑
  4. 颜色和样式得到保留

通过 API 自动化

您可以使用 Archyl API 自动化导出:

curl -X GET \
  -H "X-API-Key: your-api-key" \
  "https://api.archyl.com/api/v1/projects/{projectId}/export?format=png&level=system-context"

这使以下操作成为可能:

  • CI/CD 文档集成
  • 定时导出用于报告
  • 跨项目批量导出

JSON 导出(数据可移植性)

用于备份、迁移或分享完整的架构数据,可将项目导出为 JSON。

导出内容

JSON 导出包含您完整的 C4 模型:

  • 系统 包含描述、技术、标签和位置
  • 容器 嵌套在其父系统中
  • 组件 嵌套在其父容器中
  • 代码元素 包含方法和属性
  • 关系 包含所有元素之间的描述和样式
  • 叠加层 包含位置、尺寸和包含的元素

导出保留您的图表布局,因此导入的项目看起来与您设计的完全一样。

如何导出 JSON

  1. 打开要导出的项目
  2. 点击工具栏中的 导出
  3. 选择 JSON 格式
  4. 点击 导出
  5. 保存下载的文件

文件命名为 {project-name}-{date}.json,包含可读的 JSON。

通过 API 导出

curl -X GET \
  -H "X-API-Key: your-api-key" \
  "https://api.archyl.com/api/v1/projects/{projectId}/export"

返回完整的项目数据 JSON,支持自动备份和 CI/CD 集成。

导入项目

您可以通过从多种格式导入来创建新项目。Archyl 支持四种导入源

格式 文件类型 来源工具
Archyl YAML .yaml / .yml Archyl 原生格式
Structurizr DSL .dsl Structurizr
LikeC4 .c4 / .likec4 LikeC4
IcePanel JSON .json IcePanel

如何导入

  1. 从项目列表点击 导入项目
  2. 选择源格式标签页(Archyl YAML、Structurizr DSL、LikeC4 或 IcePanel)
  3. 上传文件或粘贴其内容
  4. 点击 验证 预览将要创建的内容
  5. 点击 创建项目

整个过程不到一分钟。所有系统、容器、组件、关系、技术和标签都会自动导入。

Structurizr DSL 导入

Archyl 解析 Structurizr 的 .dsl 工作区文件,并提取完整的 C4 模型:person、softwareSystem、container、component 元素,所有关系、技术和标签。

LikeC4 导入

Archyl 是第一个支持导入 LikeC4 文件的工具。自定义元素类型、嵌套层次结构、属性、hashtag 标签和多个模型块均受支持。

IcePanel JSON 导入

IcePanel 的 JSON 导出完全受支持:system、actor、app、store、component 类型,external 字段、modelConnections 和标签解析。

通过 MCP 导入(AI 代理)

相同的导入功能可通过 MCP 工具 import_dsl 供 AI 编码代理使用(Claude Code、Cursor、Windsurf)。

导入到现有项目

您还可以导入到现有项目中。已存在的元素会被更新;新元素会被创建。

后续步骤