作为一位web开发人员,在使用REST API的时候,是否遇到过这样的问题:
1.调用一个API的时候,总是会返回一些不需要的信息。
2. 对于一个资源的调用,如果想获取到更多的信息,可能需要发送多次请求才能获取。
那么现在是时候了解一下GraphQL了。
一、什么是GraphQL?
GraphQL是FaceBook于2012年在内部开发的数据查询语言,在2015年开源,旨在提供RESTful架构的替代方案。根据官网的介绍:
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
二、为什么使用GraphQL?
在介绍这个问题之前,先来看看REST的API吧。
在使用了 RPC 远程过程调用接口之后,你会发现REST API的优越,这正是你梦寐以求的API定义模式。
-
- 对于系统本身耦合性低,调用者不再需要了解接口内部处理和实现细节
- 重复使用了一些 http 协议中的已定义好的部分状态动词,增强语义表现力
- API可以随着时间而不断演进
但随着项目的开展,你会发现有这样一些问题:
当需要查询一个实体数据集的时候,如购物系统查询一本书籍,按照接口的定义,我们可以获取到一本书籍的所有信息。如他的ISBN,ID,name,价格,描述,等等信息。
问题:
1. 对于查询数据的接口,有时候需要获取数据的信息不一样,如在手机APP上,我可能需要一本书籍的ID,Name,价格。在Web应用上,我可能需要获取一本书籍的ISBN,Name,价格,描述等信息。这时候应该怎么办?
如果只定义一个接口,那么在手机APP上获取的数据有部分内容是冗余字段。如果定义多个接口,代码会有很多冗余代码。
2. 同样对于查询数据接口,如果获取书籍的数据的同时,我还需要获取到最近这本书籍的评价,以及相关附加信息(如标签,卖家信息)。这时候怎么办?
你可能会说,多设计几个接口,然后根据书籍的ID 等信息,多发送几次请求,就可以获取到相关信息了。但多发送几次请求,就多传递了很多附加信息。在网络带宽低的时候,也许就是个灾难了。
对于这两个问题,作为前端工程师的你可能需要追着后端开发工程师,希望他能给你提供一个便捷的方案。如改接口什么的,对于公司项目,尤其是多端(web、App、小程序等)的项目,改接口可能是牵一发而动全身的工作。
那么这个时候GraphQL闪亮登场:
就像GraphQL官方文档中说的:(要你想要的)
Ask for what you need, get exactly that
三、谁在使用GraphQL
Facebook当然不用说,全球最大同性交友网站GitHub, Twitter,国内好像现在比较少。
四、GraphQL资源总结:
- 官网https://graphql.github.io/
- 中文官网http://graphql.cn/
- GraphQL 使用指南https://www.howtographql.com/
- Prisma https://www.prisma.io/with-graphql/
- Apollo Graph https://www.apollographql.com/
- GraphQL .Net https://graphql-dotnet.github.io/docs/getting-started/introduction/ (后续的如何使用GraphQL的Demo就是参照这个文档写的)
下篇文章将介绍如何使用GraphQL.Net 与C# 结合