使用ASP.NET Core支持GraphQL -- 较为原始的方法

GraphQL简介

下面是GraphQL的定义: 
GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。 GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 API 更容易地随着时间推移而演进,还能用于构建强大的开发者工具。

GraphQL由Facebook开发,始于2012年,2015年公开。

GraphQL牛逼之处是它可以让客户端精确的查询它们想要的,不附加额外的东西,这样的话就很容易让客户端随着API的演进去使用。

例子

下面是一个简单的例子,这是一个GraphQL的查询:

{
  person  {
    name
    email
  }
}

而这个查询的响应结果是:

{
  "data": {
    "person": {
      "name": "Dave",
      "email": "[email protected]"
    }
  }
}

可以看到响应结果和查询请求的内容结构几乎是完全一样的。如果你需要person其它的信息,例如parents,那么在查询中加上这个属性即可:

{
  person  {
    name
    email
    parents {
      name
    }
  }
}

它的响应会像这样:

{
  "data": {
    "person": {
      "name": "Dave",
      "email": "[email protected]",
      "parents": [
        {
          "name": "Nick"
        },
        {
          "name": "AJ"
        },
        {
          "name": "Brian"
        }
      ]
    }
  }
}

在ASP.NET Core中支持GraphQL

GraphQL的查询通常会被发送到一个特定的GraphQL端点。在这个端点,会处理请求查询并返回GraphQL对象结果。

建立项目

下面我们就在ASP.NET Core中实现这个功能,首先建立项目: 
使用dotnet cli 在命令行输入:

dotnet new web --name graph

这样会建立一个ASP.NET Core 的空项目。项目结构如图: 

建立Model

然后建立一个Person 的Model: 

建立Repository

下面建立用于查询Person的Repository,首先是接口: 

然后是具体的Repository,里面带有一些写死的数据: 

添加GraphQL库

通过dotnet cli添加GraphQL这个库:

dotnet add package GraphQL

安装成功后,在项目文件里会有显示: 

建立GraphQL中间件

首先我需要一个GraphQL特定的Person类型类,它要包含映射到Person类的字段: 

该类需要继承于ObjectGraphType< Person>。

然后我还需要一个查询类,它里面包含对GraphQL实现的细节: 

该类需要继承于 ObjectGraphType。在这里,我把所有请求查询的字段映射到了PersonRepository的调用上。

最后是中间件: 


该类的意思就是,当请求地址是"/graphql"开头时,就会尝试读取请求的body。然后建立一个Schema对象,它的query字段的值就是PersonQuery的实例,而PersonQuery的实例又需要PersonRepository作为参数。 
最后建立一个DocumentExecuter来对这个schema进行查询,结果以JSON格式返回。

注册Repository,使用中间件

别忘了在Startup.cs里注册Repository和在管道里调用我们的中间件: 

测试

运行ASP.NET Core项目:

dotnet watch run

打开POSTMAN,首先按id查询一个Person: 

Cool,没问题。

再来一个带Parents的查询: 

最后再查询所有的Person吧: 

注意这里的查询写的是persons而不是person,这个要和PersonQuery类里面的定义一致。

结语

这只不过是使用ASP.NET Core支持GraphQL的一个原始手动实现而已。 
.NET Core有很多支持GraphQL的很方便库,例如graphql-dotnet:https://github.com/graphql-dotnet/graphql-dotnet。 
实际项目中还是需要使用这些库的。

原文地址:https://www.cnblogs.com/cgzl/p/9691323.html

时间: 2024-08-29 18:33:04

使用ASP.NET Core支持GraphQL -- 较为原始的方法的相关文章

让ASP.NET Core支持GraphQL之-GraphQL的实现原理

众所周知RESTful API是目前最流行的软件架构风格之一,它主要用于客户端和服务器交互类的软件.基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制. RESTful的优越性是毋庸置疑的,不过GraphQL也可以作为一种补充,让你的服务既支持RESTful的http调用,也容许客户端通过GraphQL支持的声明式语法调用服务. 本篇文章并不想对比RESTful和GraphQL孰轻孰重,或者那种方式更好,相关比较可以参考GraphQL的前世今生.本文旨在介绍如何在ASP.NET C

使用ASP.NET Core开发GraphQL服务器 -- 预备知识(上)

为了介绍使用ASP.NET Core构建GraphQL服务器,本文需要介绍一下GraphQL,其实看官网的文档就行. 什么是GraphQL? GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时. GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述,使得客户端能够准确地获得它需要的数据,而且没有任何冗余,也让 API 更容易地随着时间推移而演进,还能用于构建强大的开发者工具. 官网地址:https://graphql.org/ 中文网址(感觉不是官方的

【视频】使用ASP.NET Core开发GraphQL服务

GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时. GraphQL来自Facebook,它于2012年开始开发,2015年开源. GraphQL与编程语言无关,可以使用很多种语言/框架来构建Graph 服务器,包括.NET Core. 像Github,Pinterest,Coursera等公司都在使用GraphQL.Github的API到目前有4个版本,第三个版本用的是REST,而第四个版本使用的是GraphQL. 下面是GraphQL的典型应用场景: 视频教程:使

Asp.net core 通过Models 生成数据库的方法

????其实Getting Started当中有着详细的说明,https://docs.efproject.net/en/latest/platforms/aspnetcore/new-db.html.但是有网友问道,就说一下好了. 新建项目,Asp.net core,选择不适用身份验证. 添加项目引用.这里还是使用postgreSql. 在Nuget 控制台中输入命令: Install-Package Npgsql.EntityFrameworkCore.PostgreSQL Install-

在ASP.NET Core中使用Apworks开发数据服务:对HAL的支持

HAL,全称为Hypertext Application Language,它是一种简单的数据格式,它能以一种简单.统一的形式,在API中引入超链接特性,使得API的可发现性(discoverable)更强,并具有自描述的特点.使用了HAL的API会更容易地被第三方开源库所调用,并且使用起来也很方便,开发者可以像处理普通JSON数据那样去处理API数据.有关HAL的更多信息,可以参考官方网站:http://stateless.co/hal_specification.html.目前,很多REST

Taurus.MVC 支持Asp.Net Core 的过程

前言: 这些天,似乎.NET Core相关的新闻和文章经常在我眼前晃~~~ 昨天,微软又发布了.Core 2.1,又愰了一下,差点没亮瞎我的眼睛. 好吧,大概是上天给我的暗示,毕竟 CYQ.Data 早就支持上.Core了. 而 Taurus.MVC ,估计也闹委屈了,好吧,大慈大悲的怜见你一回,给你上ASP.NET Core支持吧. 又要一不小心就研究.NET Core了,这东西,只有家里的电脑有VS2017的环境,因此只能在家研究. 中间停停走走,思考了N天,最后用上三十几年的手速,敲足一天

ASP .NET CORE 根据环境变量支持多个 appsettings.json

0.背景 在开发项目的过程当中,生产环境与调试环境的配置肯定是不一样的.拿个最简单的例子来说,比如连接字符串这种东西,调试环境肯定是不能连接生产数据库的.在之前的话,这种情况只能说是你 COPY 两个同名的配置文件来进行处理.然后你在本地就使用本地的配置,生产环境就使用生产环境的配置文件,十分麻烦. 而 ASP .NET CORE 支持利用环境变量来动态配置 JSON 文件,下面就来看一下吧. 1.准备工作 首先在你的 ASP .NET CORE 项目当中添加一个 appsettings.jso

ASP.NET Core SignalR (二):支持的平台

此为系列文章,对MSDN ASP.NET Core SignalR 的官方文档进行系统学习与翻译.其中或许会添加本人对 ASP.NET Core 的浅显理解. 服务端系统要求 只要是ASP.NET Core支持的服务器平台都会支持ASP.NET Core SignalR. Javascript 客户端 JavaScript客户端 运行在NodeJS 8 以及后续版本中,支持的浏览器如下: 浏览器 版本 Microsoft Edge Current† Mozilla Firefox Current

Pro ASP.NET Core MVC 第6版 第一章

第一章 ASP.NET Core MVC 的前世今生 ASP.NET Core MVC 是一个微软公司开发的Web应用程序开发框架,它结合了MVC架构的高效性和简洁性,敏捷开发的思想和技术,和.NET 平台的最好的部分.在本章,我们将学习为什么微软创建ASP.NET Core MVC, 看看他和他的前辈的比较以及和其他类似框架的比较,最后,大概讲一下ASP.NET core MVC里面有什么新东西,还有本书中包括哪些内容. 了解ASP.NET Core MVC的历史 最开始的ASP.NET 诞生