Rails ERD 项目技术文档

1. 安装指南

1.1 系统要求

• Ruby 1.9.3 及以上版本
• ActiveRecord 3.x 至 5.0.x 版本

1.2 安装步骤

1. 安装 Graphviz：

   • 在 macOS 上，使用 Homebrew 安装：

     brew install graphviz
     

   • 在 Linux 上，使用 apt-get 安装：

     sudo apt-get install graphviz
     

2. 添加 Gem 到 Gemfile： 在 Rails 项目的 Gemfile 中添加以下内容：

   gem 'rails-erd', group: :development
   

3. 安装 Gem： 运行以下命令来安装 Gem：

   bundle install
   

4. 生成 ERD 图： 运行以下命令生成实体关系图：

   bundle exec erd
   

2. 项目的使用说明

2.1 生成 ERD 图

运行以下命令生成实体关系图：

bundle exec erd

生成的图将基于 Rails 应用中的 Active Record 模型，展示模型之间的关系。

2.2 自动生成 ERD 图

1. 运行以下命令安装自动生成功能：

   bundle exec rails g erd:install
   

2. 运行数据库迁移命令：

   bundle exec rails db:migrate
   

   迁移完成后，ERD 图将自动生成。

3. 项目 API 使用文档

3.1 配置文件

Rails ERD 支持通过命令行或 YAML 文件进行配置。配置文件的格式如下：

attributes:
  - content
  - foreign_keys
  - inheritance
disconnected: true
filename: erd
filetype: pdf
indirect: true
inheritance: false
markup: true
notation: simple
orientation: horizontal
polymorphism: false
sort: true
warn: true
title: sample title
exclude: null
only: null
only_recursion_depth: null
prepend_primary: false
cluster: false
splines: spline
fonts:
 normal: "Arial"
 bold: "Arial Bold"
 italic: "Arial Italic"

3.2 自定义选项

更多自定义选项可以在项目文档中找到，文档详细介绍了如何自定义 ERD 图的生成。

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Rails 项目的 Gemfile 中添加以下内容：

gem 'rails-erd', group: :development

然后运行：

bundle install

4.2 手动安装

可以通过以下命令手动安装 Gem：

gem install rails-erd

5. 总结

Rails ERD 是一个用于生成 Rails 应用实体关系图的工具，能够帮助开发者更好地理解和管理应用中的模型关系。通过简单的安装和配置，开发者可以轻松生成和自定义 ERD 图，提升项目的文档化和可维护性。