GraphQL:为什么要把 API 设计成图形

在前端开发中,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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    12 天前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    12 天前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    12 天前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    12 天前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    12 天前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    12 天前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    12 天前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    12 天前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    12 天前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    12 天前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    12 天前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    12 天前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    12 天前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    12 天前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    12 天前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    12 天前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    12 天前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    12 天前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    12 天前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    12 天前

相关推荐

    暂无文章