GraphQL 是一种用于 API 开发的查询语言，它可以让前端开发人员按照自己的需求精确地获取数据，从而提高 API 的效率和可用性。在 Ruby on Rails 中使用 GraphQL 可以极大地简化 API 的开发，本文将介绍如何在 Ruby on Rails 中使用 GraphQL 实现 API 开发。
安装 GraphQL
首先，我们需要安装 GraphQL。在 Ruby on Rails 中，使用 gem 命令可以轻松安装 GraphQL：
gem install graphql
创建 GraphQL API
接下来，我们需要创建 GraphQL API。在 Ruby on Rails 中，我们可以使用 rails generate 命令来创建 GraphQL API：
rails generate graphql:install
这个命令将会创建一个 app/graphql 目录和一个 app/graph 目录，在 app/graphql 目录中，我们可以创建 GraphQL 查询和类型定义。
定义类型
在 GraphQL 中，我们需要定义类型来描述数据的结构。在 Ruby on Rails 中，我们可以使用 Type 类来定义类型。例如，下面是一个 UserType 类型的定义：
Types::UserType = GraphQL::ObjectType.define do name 'User' description 'A user' field :id, !types.ID field :name, !types.String field :email, !types.String end
在这个例子中，我们定义了一个 UserType 类型，它有三个字段：id、name 和 email。
定义查询
在 GraphQL 中，我们可以使用查询来获取数据。在 Ruby on Rails 中，我们可以使用 Field 类来定义查询。例如，下面是一个 UserQuery 查询的定义：
-- -------------------- ---- -------
------------------ - --------------------- --
---- ---------------
----------- ---- - ---- -- ---
-------- ---- ---------
------- ------- ----- ---- -
--------------------
-
---在这个例子中，我们定义了一个 UserQuery 查询，它接受一个 id 参数，并返回一个 UserType 类型的结果。在 resolve 方法中，我们使用 User.find 方法来获取用户数据。
执行查询
在 Ruby on Rails 中，我们可以使用 GraphqlController 类来执行查询。例如，下面是一个 GraphqlController 类的定义：
-- -------------------- ---- -------
----- ----------------- - ---------------------
--- -------
--------- - -------------------------------
----- - --------------
-------------- - ----------------------
------- - -
- --------- --- ---- --- ------- ----- -----
- ------------- -------------
-
------ - --------------------- ---------- ---------- -------- -------- --------------- ---------------
------ ----- ------
---
-------
- ------ ---- ----- ---- ----- -- - ----- -----
--- ----------------------------
---- ---------------
---- ------
-- ------------------------
----------------------------------------
----
--
---
---- ----- ----------------------------
---------------
---- ---
--
----
----- -------------- ----------- ---------- -------------------
---
---
---在这个例子中，我们定义了一个 GraphqlController 类，并在 execute 方法中执行查询。我们使用 Schema.execute 方法来执行查询，并将结果返回给前端。
示例代码
下面是一个完整的示例代码，它演示了如何在 Ruby on Rails 中使用 GraphQL 实现 API 开发：
-- -------------------- ---- -------
- ------------------------------
--------------- - -------------------------- --
---- ------
----------- -- -----
----- ---- ---------
----- ------ -------------
----- ------- -------------
---
- ---------------------------------
------------------ - --------------------- --
---- ---------------
----------- ---- - ---- -- ---
-------- ---- ---------
------- ------- ----- ---- -
--------------------
-
---
- ---------------------
------ - ---------------------- --
----- ------------------
---
- -------------------------------------
----- ----------------- - ---------------------
--- -------
--------- - -------------------------------
----- - --------------
-------------- - ----------------------
------- - -
- --------- --- ---- --- ------- ----- -----
- ------------- -------------
-
------ - --------------------- ---------- ---------- -------- -------- --------------- ---------------
------ ----- ------
---
-------
- ------ ---- ----- ---- ----- -- - ----- -----
--- ----------------------------
---- ---------------
---- ------
-- ------------------------
----------------------------------------
----
--
---
---- ----- ----------------------------
---------------
---- ---
--
----
----- -------------- ----------- ---------- -------------------
---
---
---总结
在本文中，我们介绍了如何在 Ruby on Rails 中使用 GraphQL 实现 API 开发。我们首先安装了 GraphQL，然后创建了 GraphQL API，并定义了类型和查询。最后，我们演示了如何在 GraphqlController 类中执行查询。使用 GraphQL 可以让 API 的开发更加简单和高效，希望本文对读者能有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6615e683d10417a2225c7c77