阅读目录

一、Graphql是什么

  最近在折腾使用Github api做个微信小程序练练手,本篇文章就是在这个过程中记录。

  直接先看下GraphQL的语法风格,感受一下:

query {
repository(owner:"octocat", name:"Hello-World") {
id
}
}

  这是最最最简单的一个运用示例,效果上等价于http://graphqlapi.xxx.com/query/repository?owner=octocat&name=Hello-World ,返回的内容格式是这样:

{
"data": {
"repository": {
"id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
}
}
}

  再看下稍微复杂点的查询方式:

query {
repository(owner:"octocat", name:"Hello-World") {
issues(last:20, states:CLOSED) {
edges {
node {
title
url
labels(first:5) {
edges {
node {
name
}
}
}
}
}
}
}
}

  这是一个多级对象嵌套的查询,这里就不继续展开了。关于egde和node在下文会有少许讲解。对GraphQL有兴趣进行更深入了解的可以自行研究学习,我自己也是刚入门,不坑大家了:),官网是http://graphql.org/(这个可能打不开,可以打开国内的地址http://graphql.cn),Facebook发布的规范在 http://facebook.github.io/graphql/October2016/

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

二、.net下如何运用GraphQL

  由于我需要做一个定时任务将github上的数据定时拉到本地,所以自然的选择了后端处理的方式。找了一下.net下的GraphQL客户端,用了这个graphql-client。代码如下:

var heroRequest = new GraphQLRequest
{
Query = graphql //这里填写query的内容。
}; var graphQLClient = new GraphQLClient("https://api.github.com/graphql"); graphQLClient.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue("Safari", "537.36"));
//上面这行很关键,UserAgent一定要写上,要不然会出现403错误,花了好久才找到这个问题。
graphQLClient.DefaultRequestHeaders.Add("Authorization", "bearer token"); //这里的token是个占位,实际需要在Github上生成。
var graphQLResponse = graphQLClient.PostAsync(heroRequest).Result;

  关于token的生成以及其它的一些环境准备工作,在github上有详细的描述,参见:https://developer.github.com/v4/guides/forming-calls/#authenticating-with-graphql

  重要的事情说3遍:UserAgent一定要写上!! UserAgent一定要写上!! UserAgent一定要写上!!

三、运用GraphQL调用Github api

   Github提供的API和相关文档在https://developer.github.com/v4/ 右侧的目录树上,这次笔者需要拉取github的大量repository库,所以用到的search接口(但是很奇怪,这个接口在文档中并没有列出来,也不知道为什么)。建议大家可以先在Github提供的explorer中先测试和验证,OK了在把代码写到实际的项目中。

  接着,笔者在实现自己需要的功能时又学习了2个概念,才能正常开展下面的工作。第一个是edge与node的概念,edge可以理解为一个分页对象,其中除了包含实际的数据外还有一个cursor(返回的每条数据的唯一标识,如果要分页的话用得到这个数据,配合before与after关键字来使用)字段,实际数据就是用node表示的。

  另外GraphQL是强类型的,所以当笔者用到的search返回的结果并不是一个明确的数据对象时,先需要通过node下的__typename字段来获得实际的对象是什么。代码如下:

query {
search(query:"language:c#",type:REPOSITORY,first:1){
edges{
cursor,
node{
__typename
}
}
}
}

  得到的结果是:

{
"data": {
"search": {
"edges": [
{
"cursor": "Y3Vyc29yOjE=",
"node": {
"__typename": "Repository"
}
}
]
}
}
}

  得到的实际的数据对象是Repository之后,通过查阅Github Api的文档得到该对象有哪些字段,并且从中选择需要的字段即可。这个就是GraphQL的设计天然优势之一,按需获取。单在接下去运用的时候又需要引入一个新的概念fragment,这个可以理解为一个模板,通过这个模板来向服务端指明需要获取的数据字段。代码如下:

fragment repFragment on Repository {
name,
forkCount,
url,
createdAt,
updatedAt,
licenseInfo{ //对象嵌套
nickname //licenseInfo的nickname字段
},
stargazers{ //对象嵌套
totalCount //stargazers的totalCount字段
}
} query {
search(query:"language:c#",type:REPOSITORY,first:100){
edges{
cursor,
node{
__typename
...repFragment
}
}
}
}

  好了,这样就得到我需要的结果了。

  下面附上笔者做的Demo:https://github.com/ZacharyFan/GitHubRanking,其中的token在配置文件中自行替换即可。

四、结语

  最后附带提一下,GraphQL的出现,主要的场景还是在于赋能前端开发,赋予了前端开发者自由组织和定制请求数据的能力。这是一个将前后端分离后的界限偏向前端的框架,所以直接在前端通过GraphQL访问后端数据是个人比较推崇的方式。目前前端非常火热的GraphQL框架也不少,主流的就是下面2个: apollo(https://github.com/apollographql/apollo-client)relay(https://github.com/facebook/relay)

  GraphQL虽好,但是要真正在中大型项目中运用GraphQL,还有有很大的困难的,服务端需要支持到GraphQL的规范格式进行数据输出,我认为需要付出的成本可不小。哪怕的架设一层中间层,也需要解决诸如分发、聚合和性能等问题。

作者:Zachary
出处:https://zacharyfan.com/archives/320.html

▶关于作者:张帆(Zachary,个人微信号:Zachary-ZF)。坚持用心打磨每一篇高质量原创。欢迎扫描右侧的二维码~。

定期发表原创内容:架构设计丨分布式系统丨产品丨运营丨一些思考。

如果你是初级程序员,想提升但不知道如何下手。又或者做程序员多年,陷入了一些瓶颈想拓宽一下视野。欢迎关注我的公众号「跨界架构师」,回复「技术」,送你一份我长期收集和整理的思维导图。

如果你是运营,面对不断变化的市场束手无策。又或者想了解主流的运营策略,以丰富自己的“仓库”。欢迎关注我的公众号「跨界架构师」,回复「运营」,送你一份我长期收集和整理的思维导图。

记一次通过c#运用GraphQL调用Github api的更多相关文章

  1. 获取使用GitHub api和Jira api Authentication的方法

    近段时间在搭建我司的用例管理平台,有如下需求: 1.需要根据项目--版本--轮次的形式来管理项目用例,用例统一保存在git工程. 2.执行用例时,如果用例执行失败,可以通过平台在Jira上提bug. ...

  2. python 调用github的api,呈现python的受欢迎的程度

    1 使用api调用数据: 在浏览器的地址栏中输入: https://api.github.com/search/repositories?q=language:python&sort=star ...

  3. 调用人人网API

    大致步骤与上篇调用新浪微博API类似.只是感觉新浪微博的做的更好一些,人人网的非常多要手动操作 与新浪微博类似,先在人人网开放平台http://dev.renren.com/注冊站内应用, 把该填的填 ...

  4. 使用Retrofit2调用HTTP API

    前言 Retrofit会将你的HTTP接口调用转换为java的interface,你不必去实现这个接口,交给Retrofit来创建动态代理. 首先,贴上官网和Javadoc. 官网上的例子 加依赖,下 ...

  5. 详解C#泛型(二) 获取C#中方法的执行时间及其代码注入 详解C#泛型(一) 详解C#委托和事件(二) 详解C#特性和反射(四) 记一次.net core调用SOAP接口遇到的问题 C# WebRequest.Create 锚点“#”字符问题 根据内容来产生一个二维码

    详解C#泛型(二)   一.自定义泛型方法(Generic Method),将类型参数用作参数列表或返回值的类型: void MyFunc<T>() //声明具有一个类型参数的泛型方法 { ...

  6. 人人都是 API 设计师:我对 RESTful API、GraphQL、RPC API 的思考

    原文地址:梁桂钊的博客 博客地址:http://blog.720ui.com 欢迎关注公众号:「服务端思维」.一群同频者,一起成长,一起精进,打破认知的局限性. 有一段时间没怎么写文章了,今天提笔写一 ...

  7. C#调用windows API的一些方法

    使用C#调用windows API(从其它地方总结来的,以备查询) C#调用windows API也可以叫做C#如何直接调用非托管代码,通常有2种方法: 1.  直接调用从 DLL 导出的函数. 2. ...

  8. React Native教程 - 调用Web API

    react-native官网Fetch介绍:https://facebook.github.io/react-native/docs/network.html#content react-native ...

  9. sofa graphql 2 rest api webhook 试用

    sofa 的webhook实际上就是将graphql 的subscription 进行了扩展,当接受到sub 请求的时候 再做一次http 的转发处理,方便rest api 的访问 环境准备 环境还是 ...

随机推荐

  1. winform倒计时

    public partial class Form1 : Form { private int Seconds; public Form1() { InitializeComponent(); // ...

  2. springboot 多模块打war 部署

    先展示一下自己项目结构 一共有5个模块 依赖关系:下面的模块依赖上面所有的模块 其中 rongke-web是我要部署的模块 最终要打war进行部署,其他模块均打jar 被rongke-web引用. 开 ...

  3. GraphQL ---02 GraphQL和C#结合的实战项目

    本文章是介绍和记录如何创建GraphQL项目,以及如何使用GraphQL进行数据的相关操作.项目参照GraphQL .Net 的官方文档进行实践 一.项目结构: 为了更好的和原有的项目结合在一起,尽可 ...

  4. 两条命令,实现ssh免密登陆

    ssh-keygenssh-copy-id -i 目标服务器ip

  5. SpringCloud使用Feign调用其他客户端带参数的接口,传入参数为null或报错status 405 reading IndexService#del(Integer);

    SpringCloud使用Feign调用其他客户端带参数的接口,传入参数为null或报错status 405 reading IndexService#del(Integer); 第一种方法: 如果你 ...

  6. wxpy使用

    一 简介 wxpy基于itchat,使用了 Web 微信的通讯协议,,通过大量接口优化提升了模块的易用性,并进行丰富的功能扩展.实现了微信登录.收发消息.搜索好友.数据统计等功能. 总而言之,可用来实 ...

  7. Django DetailView 多重继承 关系整理

    0.参考 https://docs.djangoproject.com/en/2.1/topics/class-based-views/mixins/ 1.版本信息 In [157]: import ...

  8. vue小技巧之偷懒的文件路径——减少不必要的代码

    众所周知,我们写vue项目的时候都会创建很多个文件,尤其是一些中大型项目,会有很深的文件夹,当你去引入的时候,要写很长的路径比如我要引入一个css文件, 必须得 import  '../../../s ...

  9. Linux磁盘和文件系统管理

    1.检测并确认新硬盘 挂载好新的硬盘设备并启动主机后,Linux系统会自动检测并加载该硬盘,无须额外安装驱动.执行“fdisk -l”命令即可查看,确认新增硬盘的设备名称和位置.作用:列出当前系统中所 ...

  10. JAVA注释--2019-04-28

    一.JAVA自带注解 1.@Override:覆盖父类方法 2.@Deprecated:不建议使用(就是方法上画一条横线划掉那种) 3.@SuppressWarnings:去掉警告:使用方法:@Sup ...