肖恩·拉弗兰(Sean LaFlam)
5分钟阅读
并构建更好的API
什么是GraphQL?
GraphQL是Facebook开发的一种查询语言(这是QL的代表),为我们提供了一种更有效的设计,创建和访问API的方式。
它旨在通过允许您配置发出请求时要求的数据的结构和内容,来改进常规的API请求过程。
通用模式是:
- 描述您的数据
- 询问你想要什么
- 取得可预测的结果
在GraphQL之前
在GraphQL之前,标准是构建REST API,所有这些API都遵循严格的准则来提出API请求。该系统的问题在于,它为您提供了需要向其发出请求的许多不同的端点。
您是否想要某个电影API中所有电影的索引?那个端点看起来可能像这样:
https://www.moviesapi.com/movies
是否想要获取特定演员的电影列表?现在将是一个不同的端点,如下所示:
https://www.moviesapi.com/actors/7/movies
如您所见,使用RESTful约定要求您将处理许多不同端点的能力写入代码中。
它也有缺点,有时要么发送太多信息,要么发送不够。有时,由API发送回的JSON对象可以在每个键中包含许多嵌套对象。例如,在上面的API讨论中,对’/ movies’的GET请求可能会返回大量的电影列表,并且在每个电影对象中可能会有一个按键调用actor,该actor包含电影中的每个演员,并且在该演员键内,每个演员可能都有一些属性,例如个人简介,DOB,奖项列表等。如果您只是在寻找以字母B开头的电影名称列表,那将浪费大量不必要的信息。实例。
相反,也许您想要所有这些信息,但是一般的请求都不会将其发送到“ / movies”,因此您现在必须向不同的端点发出多个请求,以获取所需的所有信息,并弄清楚如何在您的前端很好地合并这些数据。
我要说的是设计这些API的常规方法可能有很多不足之处,而且无论您是谁来开发它的,您几乎都是摆布,并且必须弄清楚如何使用所获得的一切。
入门
首先,请转到GraphQL网站并阅读编程语言的文档。它们几乎支持您要使用的任何语言(JavaScript,Python,Ruby,Swift,Go,Java,C / C ++,Perl等),因此您应该能够使其适用于所构建的任何应用程序。
我个人就是一个JavaScript程序员,所以我们今天将使用这个例子,但总体信息不应该从语言到语言的大量变化。
开始之前要了解的一件事是GraphQL只是一个规范。即使它是由Facebook构建的,也不意味着您要在计算机上安装Facebook产品或由其构建的应用程序才能使用GraphQL。因此,如果您因Facebook的声誉而犹豫不决地使用Facebook建造的产品,我认为没有任何理由值得关注。
如果您单击JavaScript文档,则会看到将其分为3个部分:服务器,客户端和工具。
服务器
您会看到这里有许多选项可用于设置服务器以处理GraphQL服务器环境,其中许多选项都可以通过简单的npm安装来安装。您将必须通读每个文档,以确定最适合您的用例的。但是GraphQL.js和Apollo Server是两个最常见且可能因此易于使用(由于大量的教程和进一步的文档)。
GraphQL服务器接受您的API,并允许您通过类型定义和称为解析器的这些函数来构造其形状,这些函数定义了如何处理每个查询以及应返回的查询。
> The ‘resolver’ tells GraphQL Server how to handle a query
客户端
如果您碰巧正在使用已经设置为可以处理GraphQL的API /服务器,那么除了此简介的客户端之外,您不需要任何其他操作。客户端是前端组件,您可以在其中实际接受查询,然后在后端请求数据。
> Again, there are many libraries to choose from on the Client side
有关每种语言的GraphQL客户端部分的每个语言都有更详细的文档,但它们再次使用NPM Install轻松安装,并且记录得很好。
让我们看一个例子
好的,到目前为止,所有内容都还很模糊,只是使您对GraphQL有更高的了解。现在让我们看一个实际查询和响应的示例。回到我们的电影数据库示例,一个简单的查询可能看起来像这样:
{
movie(id: "157") {
name
director
year
}
}
基本上是说,去找ID为157的电影,然后告诉我导演和上映年份。
作为回应,我们将收到以下内容:
{
"data": {
"movie": {
"name": "Shrek",
"director": "Andrew Adamson"
"year": "2001"
}
}
}
我们将完全返回我们从API要求的内容。不多不少。我们并没有获得电影中每个演员的列表,也不必向多个端点提出多个请求。
让我们更进一步。根据后端服务器的设置方式,您可以执行以下操作:
{
movie(id: "157") {
name
year
director {
movies
}
}
}
然后,您将获得导演完成的电影列表:
{
"data": {
"movie": {
"name": "Shrek",
"director": "Andrew Adamson" {
"movies": [
"name": "Shrek 2",
"name": "Shrek the Third",
"name": "Shrek 4ever After",
]}
"year": "2001"
}
}
}
如您所见,它是非常可定制的,您可以找回要查找的确切数据结构,而不必尝试进行一系列不同的调用并通过混杂的JSON对象进行排序以找到所需的内容。
有关更多信息,请务必阅读官方文档并尝试实现您自己的GraphQL API!
(本文由闻数起舞翻译自37 Followers的文章《An Introduction to GraphQL》,转载请注明出处,原文链接:
https://laflamablanc.medium.com/an-introduction-to-graphql-5a9714a5cced)