GraphQL学习:Github GraphQL API v4初探

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

什么是GraphQL

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

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

为何Github选用GraphQL呢?由于GraphQL具备如下好处:dom

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

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

image

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

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

GraphQL中文网学习。网站

相信你也不爱一会儿看到超多陌生概念,咱们还行边用边学吧ui

初探

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

一个小小案例

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

相关文章
相关标签/搜索