graphql-activerecord 项目教程

graphql-activerecord 项目教程

graphql-activerecord项目地址:https://gitcode.com/gh_mirrors/gr/graphql-activerecord

项目介绍

graphql-activerecord 是一个 Ruby 库，旨在帮助开发者基于 ActiveRecord 模型构建兼容 Relay 的 GraphQL 模式。该项目通过提供一系列辅助方法和工具，简化了在 Rails 应用中集成 GraphQL 的过程。

项目快速启动

安装

首先，将以下代码添加到你的 Gemfile 中：

gem 'graphql-activerecord'

然后执行：

bundle install

配置

在你的 Rails 应用中，创建一个初始化文件 config/initializers/graphql_activerecord.rb，并添加以下内容：

# 这个 proc 接收一个 Relay 全局 ID 并返回 Active Record 模型
GraphQL::Models.model_from_id = -> (id, context) {
  model_type, model_id = NodeHelpers.decode_id(id)
  model_type.find(model_id)
}

# 这个 proc 本质上反转上述过程
GraphQL::Models.id_for_model = -> (model_type_name, model_id) {
  NodeHelpers.encode_id(model_type_name, model_id)
}

使用示例

在你的 GraphQL 对象类型中，使用 backed_by_model 方法创建与模型绑定的字段：

class EmployeeType < GraphQL::Schema::Object
  backed_by_model :employee do
    attr :first_name
    attr :last_name
  end
end

应用案例和最佳实践

应用案例

假设你有一个 Employee 模型，你可以通过以下方式在 GraphQL 模式中定义相关字段：

class Employee < ApplicationRecord
  enum status: [:active, :inactive]
end

class EmployeeType < GraphQL::Schema::Object
  backed_by_model :employee do
    attr :first_name
    attr :last_name
    attr :status
  end
end

最佳实践

1. 使用枚举类型：对于模型中的枚举字段，使用 graphql_enum 方法自动生成 GraphQL 枚举类型。
2. 授权控制：在定义突变时，确保添加授权逻辑以控制对模型的更改。

典型生态项目

graphql-activerecord 通常与其他 GraphQL 相关库一起使用，例如：

• graphql-ruby：用于构建 GraphQL 服务器的核心库。
• graphql-batch：用于批量加载数据的库，提高性能。

这些库与 graphql-activerecord 结合使用，可以构建出高效且功能丰富的 GraphQL API。

graphql-activerecord项目地址:https://gitcode.com/gh_mirrors/gr/graphql-activerecord