GraphQL学习:Github GraphQL API v4初探

GraphQL学习:Github GraphQL API v4初探

查看GithubAPI的时候,发现github API升级成了V4,并且叫GraphQL API v4。不禁大吃一惊,这是个什么东东。

什么是GraphQL

GraphQL(Graph Query Language):GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义)。

GraphQL是一门语言,专门用于API查询。可以类比到SQL,这种类型的语言学名叫DSL(domain-specific language),译作领域专用语言

为什么Github选用GraphQL呢?因为GraphQL具有以下好处:

  • 更大的灵活性
  • 精确定义所需数据的能力(GraphQL拥有强类型)
  • 仅仅会返回你需要的数据(避免数据冗余)
  • GraphQL允许您通过一次调用替换多个REST请求以获取指定的数据

放一张来自图说明下工作过程:

image

看起来与原本的REST API没什么两样。

是的,大致的工作流程就是如此,不过GraphQL作为一门语言,其中有许多的概念和语法。但是我不想纯粹做官方文档的copyer,而是作为官方文档的一个导学,具体的概念和语法可以去

GraphQL中文网学习。

相信你也不爱一下子看到超多陌生概念,我们还行边用边学吧

初探

github提供了GraphQL Explorer来辅助GraphQL学习

一个小小案例

打开GraphQL Explorer这里我们先来运行下面的代码:

query { 
  viewer { 
    login
  }
}

这段代码可以查询你github的用户名,注意,请先登录。

我运行的结果:

{
  "data": {
    "viewer": {
      "login": "smarxpan"
    }
  }
}

这里你可能会产生疑惑,为什么接口可以这样请求,到底发生了什么魔法?

打开抓包软件,我们来抓个包看看。

上面的请求,实际上发送的内容仍旧是个json:

{
    "query": "query { \n  viewer { \n    login\n  }\n}",
    "variables": {}
}

这里没有什么魔法,我们看到那段代码的内容作为query参数的值发送给了服务端,服务端按照语法对其进行解析,然后返回给我们需要的值。

小小案例的具体解释

query { 
  viewer { 
    login
  }
}

这一小段的第一句:query

GraphQL中有两种操作:query和mutation。query代表查询,mutation是变更。查询就是请求数据,而变更,对应REST API的POST/PATCH/DELETE。

这两种操作使用的请求方式均为post,get请求在GraphQL不常用。

query的结构类似:

query {
  JSON objects to return
}

其内部定义的是要返回数据的json结构。

学习和使用指引

最佳的示例当然是《Github GraphQL Guides》,其中有示例、可运行,里面的每段代码都可点击到explorer里运行。

语法学习还是推荐GraphQL中文网:《GraphQL 入门》

还有一篇博客我觉得特别棒,是Leetcode工作的一位大神的《阻碍你使用 GraphQL 的十个问题》

而真正使用到工作中,当然少不了库的使用

GraphQL服务端库

GraphQL客户端库

目前主流的开发语言均有具体实现,取决于你使用的是哪一种语言,选择自己的开发库用起来。

结语

新技术无疑是让人兴奋的,GraphQL确实解决了不少痛点,如果项目没什么历史包袱可以搞一搞。Github作为世界上最大的同性交友网站,其在API上使用该语言相信会带动业界的进步,学就完了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,230评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,261评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,089评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,542评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,542评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,544评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,922评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,578评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,816评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,576评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,658评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,359评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,937评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,920评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,859评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,381评论 2 342

推荐阅读更多精彩内容