Draft 项目使用教程

1. 项目介绍

Draft 是一个命令行工具，用于生成高层次的微服务和无服务器架构图。它使用 YAML 语法定义架构，并通过 Graphviz 生成可视化图表。Draft 支持 Linux、macOS 和 Windows 平台，旨在帮助开发者通过简单的 YAML 文件快速生成复杂的云架构图。

2. 项目快速启动

安装步骤

1. 克隆仓库：

   git clone https://github.com/lucasepe/draft.git
   

2. 进入 cmd 目录：

   cd draft/cmd
   

3. 生成静态资源：

   go generate ./...
   

4. 构建二进制工具：

   go build -o draft
   

使用示例

假设你有一个 YAML 文件 example.yml，你可以使用以下命令生成 PNG 格式的架构图：

./draft example.yml | dot -Tpng -Gdpi=200 > example.png

3. 应用案例和最佳实践

应用案例

• 微服务架构图：通过 Draft 可以快速生成微服务架构图，帮助团队理解和规划微服务架构。
• 无服务器架构图：Draft 支持生成无服务器架构图，适用于使用 AWS Lambda、Azure Functions 等无服务器服务的项目。

最佳实践

• 使用自定义图标：可以通过设置 DRAFT_ICONS_PATH 环境变量，使用特定云提供商（如 AWS、Google Cloud、Azure）的图标。
• 连接组件：在 YAML 文件中定义组件之间的连接关系，Draft 会自动生成相应的连接箭头。

4. 典型生态项目

• Graphviz：Draft 依赖 Graphviz 生成最终的图表。Graphviz 是一个开源的图形可视化工具，支持多种输出格式。
• YAML：Draft 使用 YAML 作为输入格式，YAML 是一种人类友好的数据序列化标准，广泛用于配置文件和数据交换。

通过以上步骤，你可以快速上手并使用 Draft 工具生成高层次的云架构图。