GraphQL 是一种由 Facebook 开发的用于构建 Web API 的查询语言，它使用类型系统来描述数据的结构，并允许客户端通过简单的查询语句指定需要的数据。与传统的 RESTful API 相比，GraphQL 可以提供更加灵活和精确的数据访问方式，同时减少了不必要的数据传输，提升了性能和用户体验。
在本文中，我们将介绍如何使用 ASP.NET Core 2.2 和 C# 构建一个简单的 GraphQL API，包括定义类型、查询和变更，以及处理数据源。通过本文，你将学习到如何快速构建高效的 GraphQL API，以及如何在项目中扩展和优化 GraphQL。
安装环境
在开始构建我们的 GraphQL API 之前，我们需要安装一些必要的工具和依赖。首先，我们需要安装 .NET Core SDK，它是一个跨平台的开发框架，可以在 Windows、macOS 和 Linux 上运行。
你可以从 Microsoft 的官方网站 https://dot.net/core 下载最新版本的 .NET Core SDK。
在安装完成之后，我们可以使用以下命令行检查是否已成功安装：
$ dotnet --version 2.2.300
接下来，我们需要安装 GraphQL.NET，它是一个用于 .NET 开发的 GraphQL 库，提供了丰富的API和工具，可帮助我们快速构建高效的 GraphQL API。
你可以使用以下 NuGet 包管理器安装 GraphQL.NET：
$ dotnet add package GraphQL
定义数据模型
在开始实现 GraphQL API 之前，我们需要先定义数据模型。数据模型描述了我们将要使用的数据的结构和字段类型。
在本例中，我们将使用一个简单的电影评分应用程序作为示例，该应用程序包含三个数据对象：电影、用户和评分。
我们创建一个名为 MovieRating 的 C# 类库项目，并定义以下数据模型：
-- -------------------- ---- -------
------ ----- -----
-
------ --- -- - ---- ---- -
------ ------ ----- - ---- ---- -
------ ------ -------- - ---- ---- -
------ --- ----------- - ---- ---- -
-
------ ----- ----
-
------ --- -- - ---- ---- -
------ ------ ---- - ---- ---- -
-
------ ----- ------
-
------ --- -- - ---- ---- -
------ --- ------- - ---- ---- -
------ --- ------ - ---- ---- -
------ ----- ----- - ---- ---- -
-定义查询类型
现在我们已经定义了数据模型，接下来我们需要定义查询类型。查询类型描述了客户端如何从数据源中获取数据。例如，我们可以定义一个名为 Query 的类型，并将其用于从数据源中检索电影列表和单部电影。
使用 GraphQL.NET，我们可以定义查询类型如下：
-- -------------------- ---- -------
------ ----- -----
-
------- -------- ----------- ------- - --- -----------
-
--- ----- - -- - -- ----- - ---- --------- ------------ -------- - ---- ---------- --- ---- ---- - ------ -- ------ ------- ------ --- -------- ---------- ------- ---- -- ------ ---------- ----------- - ---- --
--- ----- - -- - -- ----- - ---- ----------- -------- - ---- ----- --------- -- -- --------- ----- ------- --------- ------- -- --- ----------- ------ -- --- --------- ------ ----------- - ---- --
--- ----- - -- - -- ----- - ---- ---- -------- -------- - ----- --- ------ ----- -- --- ----- ------- ---- --- ---------- ----- -- ------ ----- --- ----- -- --- ------ -- ------- --- ---- ------ ---- ------ --- -- --- -------- ------------- --- -------- ----- -- --- ------- -- ----- ------------ ----------- - ---- -
--
------ ------------------ --------
-
------ --------
-
------ ----- --------- ---
-
------ ------------------------ -- ---- -- ----
-
-在这个示例中，我们使用了一个私有列表来存储电影数据，然后定义了两个方法：一个用于检索所有电影，一个用于根据 ID 检索单部电影。
定义变更类型
除了检索数据之外，GraphQL 还允许我们进行变更操作。变更类型描述了客户端如何修改数据源。例如，我们可以定义一个名为 Mutation 的类型，并将其用于添加、更新和删除电影。
使用 GraphQL.NET，我们可以定义变更类型如下：
-- -------------------- ---- -------
------ ----- --------
-
------- -------- ----------- ------- - --- --------------
------ ----- --------------- ------ ------ --------- --- ------------
-
--- ----- - --- -----
-
-- - ------------- - --
----- - ------
-------- - ---------
----------- - -----------
--
-------------------
------ ------
-
------ ----- --------------- --- ------ ------ ------ --------- --- ------------
-
--- ----- - ------------------------ -- ---- -- ----
-- ------ -- -----
-
----------- - ------
-------------- - ---------
----------------- - ------------
-
------ ------
-
------ ---- --------------- ---
-
--- ----- - ------------------------ -- ---- -- ----
-- ------ -- -----
-
----------------------
------ -----
-
------ ------
-
-在这个示例中，我们使用一个私有列表来存储电影数据，然后定义了三个方法：一个用于添加电影，一个用于更新电影，一个用于删除电影。
定义数据源类型
现在我们已经定义了数据模型、查询类型和变更类型，接下来我们需要定义数据源类型，将查询类型和变更类型连接到实际的数据源上。
使用 GraphQL.NET，我们可以定义数据源类型如下：
public class MovieRatingSchema : Schema
{
public MovieRatingSchema(IDependencyResolver resolver) : base(resolver)
{
Query = resolver.Resolve<Query>();
Mutation = resolver.Resolve<Mutation>();
}
}在这个示例中，我们创建了一个名为 MovieRatingSchema 的类，它继承了 GraphQL.NET 的 Schema 类。我们还将查询类型和变更类型注入到了依赖关系解析器中，以便在创建 Schema 实例时使用。
启动服务器
现在我们已经定义了所有必要的类型和操作，接下来我们需要启动一个 Web 服务器，以便客户端可以通过 HTTP 请求访问我们的 GraphQL API。
使用 ASP.NET Core，我们可以启动一个 Kestrel 服务器，监听 HTTP 请求。以下是我们如何启动服务器的示例代码：
-- -------------------- ---- -------
------ ------ ---- ------------- -----
-
--- ------ - --- --------------------- ------------------------ --
-
-- -- -- --------------
-
------ --- --------
-
---- -- -- -- -----------------
-
------ --- -----------
-
----
-
------ -----
-
----
--- -------------- - --- ------------------------
-
------------- - -----
---------------- - ----
--
------------------------------------
---------------------------- ----------------------------
------------- --------- --
-
----- ------------------------------------ --- -- -------------
---
-在这个示例中，我们创建了一个 Schema 实例，并使用 FuncDependencyResolver 将查询类型和变更类型注入到依赖关系解析器中。我们还启用了 GraphQL 库的一些选项，如指标和异常处理，并使用 UseGraphQL 和 UseGraphQLPlayground 方法将它们添加到 ASP.NET Core 应用程序中。最后，我们使用 Run 方法启动了一个简单的 HTTP 服务器，并返回了一条欢迎消息。
执行 GraphQL 查询
现在我们已经启动了 GraphQL API 服务器，它监听在 http://localhost:5000 上。接下来，我们可以使用任何 HTTP 客户端发送 GraphQL 查询，例如 GraphiQL 或 Postman。
在这个示例中，我们可以使用 GraphiQL 发送以下查询：
-- -------------------- ---- -------
-
------ -
--
-----
--------
-----------
-
--------- -- -
--
-----
--------
-----------
-
-这个查询将检索所有电影，以及 ID 为 1 的单部电影。
在变更方面，我们可以使用以下查询来添加、更新和删除电影：
-- -------------------- ---- -------
-------- -
--------------- ---- -------- --------- -- -------- ------ ------ ---- ---------- ------ ----- --- ---- ------ -- --- ------- --- --- ---- -- --- --- ------- --- -------------- ------------ ----- -
--
-----
--------
-----------
-
--------------- -- ------ ---- --------- ------------ --------- ---- ---------- --- ---- ---- - ------ -- ------ ------- ------ --- -------- ---------- ------- ---- -- ------ ---------- ------------ ----- -
--
-----
--------
-----------
-
--------------- --
-这个查询将添加一部新电影，更新一部现有电影，以及删除一部现有电影。
总结
通过本文，我们学习了如何使用 ASP.NET Core 2.2 和 C# 构建 GraphQL API，并定义了数据模型、查询类型和变更类型。我们还介绍了如何连接查询类型和变更类型到实际的数据源中，以及如何启动一个简单的 Web 服务器来监听 HTTP 请求。
GraphQL 是一个功能强大、灵活和精确的查询语言，可以大大简化客户端和服务器之间的数据交互，并提高应用程序的性能和用户体验。通过学习本文中的示例，你可以快速上手 GraphQL，并在自己的项目中使用它来改善数据交互的方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/651a295595b1f8cacd22bc1f