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上使用该语言相信会带动业界的进步,学就完了。

推荐阅读更多精彩内容