GraphQL — API查询语言

API,AJAX,REST,后端分离,前端三大框架,在单页应用成为主流的今天,基本上无人不知。相比起传统的MVC架构,带来的好处也是显而易见的。实现简单,方便灵活,对用户非常友好。

Restful

大量使用AJAX进行异步数据请求是现在单页应用获取数据的主要方法,对此也有一套专门的方案(Restful)虽然基本上满足大部分操作,但还是有很多不足的地方。

在这样的风格下,每个版本,每个对象都有特定的url,往往一个项目中会有成堆的url。对于前端开发人员来说,很多时候要求返回特定格式的数据。为了节约网络资源,加快访问速度,有时候需要要求返回指定的字段。等等等等。。

这些功能当然都可以实现,因为在restful风格下,查询(query)操作使用get的方式进行请求,与服务器的交互仅通过url携带参数,多少都很别扭。如果能把这样的操作都进行函数化,那就再好不过了。

Graphql很好的规避了这些问题,一个url,全部的操作都以函数为中心,使用起来非常方便灵活。

GraphQL

本文将以Github的API为例,说明Graphql的基本使用方法,更全面的使用教程请参阅GraphQL

GraphiQL

GraphQL自带了强大的自省功能,类似于传统restful API的自动化文档。引入GraphiQL即可在页面中直接进行各种操作,在右侧的边栏中可以查看当前可进行的各种操作以及具体的返回数据。打开github提供的资源管理器,开始愉快的进行吧!

Query

通俗的讲,在Graphql中只有两类操作,一种是只读型的query,另外一种是对服务器资源造成修改的mutation

登录后在explorer中输入

query {
  viewer {
    login
  }
}

得到返回数据

{
  "data": {
    "viewer": {
      "login": "myWsq"
    }
  }
}

一次愉快的查询就这样完成了。当然可以指定要查询的字段,打开explorer的右侧Doc边栏,在query中找到viewer对象:

viewer: User!

这意味着viewer必须返回一个user实例,同样的,打开user的定义,看到很多字段。我们在查询语句中加入其它字段:

query {
  viewer {
    login
    name
    bio
  }
}

得到返回数据

{
  "data": {
    "viewer": {
      "login": "myWsq",
      "name": "WangSQ",
      "bio": "洋码子工作者"
    }
  }
}

带参数的查询

query {
  user(login: "myWsq") {
    name
  }
}
{
  "data": {
    "user": {
      "name": "WangSQ"
    }
  }
}

嵌套查询

query {
  user(login: "myWsq") {
    name
    repositories(last:1) {
      edges {
        node {
          name
        }
      }
    }
  }
}
{
  "data": {
    "user": {
      "name": "WangSQ",
      "repositories": {
        "edges": [
          {
            "node": {
              "name": "blog.mywsq.cn"
            }
          }
        ]
      }
    }
  }
}

多个对象同时查询

query {
  user(login: "myWsq") {
    name
  }
  viewer{
    login
  }
}
{
  "data": {
    "user": {
      "name": "WangSQ"
    },
    "viewer": {
      "login": "myWsq"
    }
  }
}

mutation

github提供的explorer不支持mutation,可以在自己的GraphiQL实例中使用,但是我们能从Doc中看出,mutation的使用与query非常相似。

Input

找到一个mutation操作

addStar(input: AddStarInput!): AddStarPayload

可以将addStar看做一个对象,实际上,在GraphQL服务端编程时,它确实是一个对象。加上参数便成为了函数。带有input后缀的是服务端定义的输入对象,使用起来与普通对象并无差别。只是服务器在处理时为了处理数据,方便区分。

可以看出,GraphQL的风格比较符合一般的函数式语言的规范,上手非常迅速。使用query操作时,并非必须携带query前缀

{
  user(login: "myWsq") {
    name
  }
  viewer{
    login
  }
}

但进行mutation操作时必须注明

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

推荐阅读更多精彩内容