在前端开发中,API 是一个非常重要的概念。而现在有一种被称为 GraphQL 的 API 模式,其最核心的理念就是将 API 设计成图形,这种做法有什么好处呢?接下来,我们将详细解释 GraphQL 做法的优势,并提供一些学习和指导的建议。
GraphQL 简介
GraphQL 是一种用于 API 构建的查询语言。它允许我们在一个 API 调用中定义我们所需要的信息,而不是通过多个调用返回多个资源来完成,这使得我们可以更高效地获取所需数据。
GraphQL 具有以下特点:
- 定义完整和精确定义数据的查询方式
- 可以获取多个资源和类型的数据
- 通过查询参数和别名来定制数据集
- 使用明确的错误信息和带列出字段的类型定义进行错误处理
GraphQL 将所有数据模式都表示为图形(Graph),图形由节点和边组成,应用程序可以定义自己的模式并向客户端公开,而客户端则可以指定需要获取的数据,这种做法被称为“Schema-Driven Development”。
为什么要用 GraphQL 设计 API
传统的 RESTful API 被设计成资源驱动,而 GraphQL 的出现则更加关注于客户端的数据需求。在 RESTful API 中,通常需要执行多个请求来完整获取信息,而 GraphQL 的查询可以一次性获取所需数据,将数据相关性与结构直接嵌套在查询中,减少网络传输的数量和复杂程度。
使用 GraphQL,开发者还可以避免过度查询和设置多个接口的情况,使得查询和数据组合更加灵活方便,同时避免了资源冗余,增加了查询和缓存效率。
GraphQL 还可以在服务器级别处理多个客户端的查询。与 RESTful API 不同的是,GraphQL 的查询语言只定义在服务器一次请求中返回的数据的结构,这意味着它也能够完全控制数据加载,从而使积累的网络负荷减少到最低限度。
GraphQL 的核心特性
GraphQL 为 API 设计的核心特性包括以下几个方面:
定义了所有类型
GraphQL 是一种类型化的查询语言,其中所有的查询的结果都是已定义的类型。例如,当我们查询某个物品时,我们可以明确地查找它是一个字符串,还是一个数字。
定义完整的查询方式
GraphQL 允许使用者模糊地描述其查询,从而自定义需要返回的数据和相关数据类型,更加透明和易于使用。
支持查询多个资源
GraphQL 不仅支持单个资源的查询,还支持多项数据的查询和级联查询,这意味着用户可以一次性在单个 API 请求中获取所有所需的数据。
使用别名定制数据集合
GraphQL 还支持使用别名来自定义大数据访问的查询集合,并在 API 响应中返回数据。
明确的错误信息
GraphQL API 可以在查询中快速标识并处理错误,并通过清晰的错误信息提供反馈。
使用 GraphQL 的实例
下面我们通过一个简单的示例来展示 GraphQL 的具体应用。
我们假设我们正在编写一个电子商务应用程序中的商品列表视图。如果我们使用 RESTful API,我们可能需要拉取一堆不同的细粒度端点(例如商品、品牌、类别等)。而如果我们使用 GraphQL,则可以定义查询来收集此类数据,如下所示:
-- -------------------- ---- ------- ----- ----------- - ----------- - -- --------- -- ---- ----- - -- ---- - -------- - -- ---- - -------- - -- ---- - - -
在这个例子中,我们使用 allProducts
查询来返回所有商品的 ID、名称、品牌、类别和变体信息。
如此一来,我们将一次性获取所有商品信息,并且能够轻松定义查询参数、别名和响应结构,提高了效率和可读性。
总结
GraphQL 在 API 设计中的优点不言而喻,可以提高查询与数据加载的效率,提高 API 灵活性,使客户端与服务器端更加容易地沟通。GraphQL 还可以提供现代化的 API 设计体验,减少错误率并改进数据安全。
然而,虽然使用 GraphQL 设计 API 会优化很多方面,但这并不总是正确的API 模式。需要注意,对于简单的项目,RESTful API 可能会更加适合,具体要看项目的需求和类型而定。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/645e100a968c7c53b0079716