使用 ASP.NET Core 2.2 和 C# 构建 GraphQL API

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。

在安装完成之后，我们可以使用以下命令行检查是否已成功安装：

- ------ ---------
-------

接下来，我们需要安装 GraphQL.NET，它是一个用于 .NET 开发的 GraphQL 库，提供了丰富的API和工具，可帮助我们快速构建高效的 GraphQL API。

你可以使用以下 NuGet 包管理器安装 GraphQL.NET：

- ------ --- ------- -------

定义数据模型

在开始实现 GraphQL API 之前，我们需要先定义数据模型。数据模型描述了我们将要使用的数据的结构和字段类型。

在本例中，我们将使用一个简单的电影评分应用程序作为示例，该应用程序包含三个数据对象：电影、用户和评分。

我们创建一个名为 MovieRating 的 C# 类库项目，并定义以下数据模型：

------ ----- -----
-
    ------ --- -- - ---- ---- -
    ------ ------ ----- - ---- ---- -
    ------ ------ -------- - ---- ---- -
    ------ --- ----------- - ---- ---- -
-

------ ----- ----
-
    ------ --- -- - ---- ---- -
    ------ ------ ---- - ---- ---- -
-

------ ----- ------
-
    ------ --- -- - ---- ---- -
    ------ --- ------- - ---- ---- -
    ------ --- ------ - ---- ---- -
    ------ ----- ----- - ---- ---- -
-

定义查询类型

现在我们已经定义了数据模型，接下来我们需要定义查询类型。查询类型描述了客户端如何从数据源中获取数据。例如，我们可以定义一个名为 Query 的类型，并将其用于从数据源中检索电影列表和单部电影。

使用 GraphQL.NET，我们可以定义查询类型如下：

------ ----- -----
-
    ------- -------- ----------- ------- - --- -----------
    -
        --- ----- - -- - -- ----- - ---- --------- ------------ -------- - ---- ---------- --- ---- ---- - ------ -- ------ ------- ------ --- -------- ---------- ------- ---- -- ------ ---------- ----------- - ---- --
        --- ----- - -- - -- ----- - ---- ----------- -------- - ---- ----- --------- -- -- --------- ----- ------- --------- ------- -- --- ----------- ------ -- --- --------- ------ ----------- - ---- --
        --- ----- - -- - -- ----- - ---- ---- -------- -------- - ----- --- ------ ----- -- --- ----- ------- ---- --- ---------- ----- -- ------ ----- --- ----- -- --- ------ -- ------- --- ---- ------ ---- ------ --- -- --- -------- ------------- --- -------- ----- -- --- ------- -- ----- ------------ ----------- - ---- -
    --

    ------ ------------------ --------
    -
        ------ --------
    -

    ------ ----- --------- ---
    -
        ------ ------------------------ -- ---- -- ----
    -
-

在这个示例中，我们使用了一个私有列表来存储电影数据，然后定义了两个方法：一个用于检索所有电影，一个用于根据 ID 检索单部电影。

定义变更类型

除了检索数据之外，GraphQL 还允许我们进行变更操作。变更类型描述了客户端如何修改数据源。例如，我们可以定义一个名为 Mutation 的类型，并将其用于添加、更新和删除电影。

使用 GraphQL.NET，我们可以定义变更类型如下：

------ ----- --------
-
    ------- -------- ----------- ------- - --- --------------

    ------ ----- --------------- ------ ------ --------- --- ------------
    -
        --- ----- - --- -----
        -
            -- - ------------- - --
            ----- - ------
            -------- - ---------
            ----------- - -----------
        --

        -------------------

        ------ ------
    -

    ------ ----- --------------- --- ------ ------ ------ --------- --- ------------
    -
        --- ----- - ------------------------ -- ---- -- ----

        -- ------ -- -----
        -
            ----------- - ------
            -------------- - ---------
            ----------------- - ------------
        -

        ------ ------
    -

    ------ ---- --------------- ---
    -
        --- ----- - ------------------------ -- ---- -- ----

        -- ------ -- -----
        -
            ----------------------

            ------ -----
        -

        ------ ------
    -
-

在这个示例中，我们使用一个私有列表来存储电影数据，然后定义了三个方法：一个用于添加电影，一个用于更新电影，一个用于删除电影。

定义数据源类型

现在我们已经定义了数据模型、查询类型和变更类型，接下来我们需要定义数据源类型，将查询类型和变更类型连接到实际的数据源上。

使用 GraphQL.NET，我们可以定义数据源类型如下：

------ ----- ----------------- - ------
-
    ------ ------------------------------------- --------- - --------------
    -
        ----- - --------------------------
        -------- - -----------------------------
    -
-

在这个示例中，我们创建了一个名为 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

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐