查看 GithubAPI 的时候, 发现 GitHub API 升级成了 V4, 并且叫 GraphQL API v4 https://developer.github.com/v4/ . 不禁大吃一惊, 这是个什么东东.
什么是 GraphQL
GraphQL(Graph Query Language):GraphQL 是一个用于 API 的查询语言, 是一个使用基于类型系统来执行查询的服务端运行时 (类型系统由你的数据定义).
GraphQL 是一门语言, 专门用于 API 查询. 可以类比到 SQL, 这种类型的语言学名叫 DSL(domain-specific language), 译作领域专用语言
为什么 GitHub 选用 GraphQL 呢? 因为 GraphQL 具有以下好处:
更大的灵活性
精确定义所需数据的能力 (GraphQL 拥有强类型)
仅仅会返回你需要的数据 (避免数据冗余)
GraphQL 允许您通过一次调用替换多个 REST 请求以获取指定的数据
放一张来自图说明下工作过程:
看起来与原本的 REST API 没什么两样.
是的, 大致的工作流程就是如此, 不过 GraphQL 作为一门语言, 其中有许多的概念和语法. 但是我不想纯粹做官方文档的 copyer, 而是作为官方文档的一个导学, 具体的概念和语法可以去
GraphQL 中文网 http://graphql.cn/learn/ 学习.
相信你也不爱一下子看到超多陌生概念, 我们还行边用边学吧
初探
GitHub 提供了 GraphQL Explorer https://developer.github.com/v4/explorer/ 来辅助 GraphQL 学习
一个小小案例
打开 GraphQL Explorer https://developer.github.com/v4/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》 https://developer.github.com/v4/guides/ , 其中有示例, 可运行, 里面的每段代码都可点击到 explorer 里运行.
语法学习还是推荐 GraphQL 中文网:《GraphQL 入门》 http://graphql.cn/learn
还有一篇博客我觉得特别棒, 是 Leetcode 工作的一位大神的《阻碍你使用 GraphQL 的十个问题》
而真正使用到工作中, 当然少不了库的使用
GraphQL 服务端库
GraphQL 客户端库
目前主流的开发语言均有具体实现, 取决于你使用的是哪一种语言, 选择自己的开发库用起来.
结语
新技术无疑是让人兴奋的, GraphQL 确实解决了不少痛点, 如果项目没什么历史包袱可以搞一搞. GitHub 作为世界上最大的同性交友网站, 其在 API 上使用该语言相信会带动业界的进步, 学就完了.
来源: https://juejin.im/post/5c1b93166fb9a049a62c8b57