GraphQL 集成 Restful API 的最佳实践

在前端开发中，使用 Restful API 是非常常见的方式来获取数据和与后端进行交互。然而，随着 Web 应用的复杂度的提高，在某些情况下，Restful API 的设计可能会变得非常的复杂和冗长。而 GraphQL ，一种新兴的 API 查询语言，能够很好的解决这个问题。本文将介绍 GraphQL 集成 Restful API 的最佳实践。

什么是 GraphQL?

GraphQL 是一种由 Facebook 开发的 API 查询语言。与传统的 Restful API 不一样，GraphQL 允许客户端请求一个特定的数据集，从而减少了数据冗余和额外的请求。GraphQL 具有以下优点:

  • 灵活性: GraphQL 允许客户端自定义请求数据的结构和内容，
  • 一次请求多个数据: 在一个 GraphQL 请求中，客户端可以请求一系列相关联的数据。
  • 自描述性: GraphQL 接口自描述，即客户端可以根据服务端提供的 schema 来获取支持的操作和数据结构。
  • 强类型: GraphQL 接口具有强类型系统，这意味着客户端在编写查询语句时就能发现许多错误。

随着 GraphQL 的流行，许多实现和库已经被开发用于各种编程语言和 Web 框架，包括 React, Vue 和 Angular。

Restful API 的缺点

虽然 Restful API 越来越流行，但是在某些情况下，其设计可能变得非常冗长和复杂。以下是一些 Restful API 的缺点:

  • 过多的请求: 对于一些情况下，可能需要从多个 URL 加载相同的信息。
  • 冗余数据: 在 Restful API 中，客户端经常需要返回与请求相关联的其他元数据。
  • 不同端点之间的协调: API 端点可能会与软件开发周期中的不同迭代版本相关联，这可能会导致数据存储的不一致。
  • 需要处理大量的响应数据: Restful API 通常会以深层嵌套的形式返回数据，这可能不利于处理。

GraphQL 的优点

GraphQL 的设计解决了许多 Restful API 的缺点。GraphQL 规范允许模块化、可维护的代码，并提供多个端点的 unique and customizable entry points。GraphQL 架构允许客户端发送更少的请求，减少网络流量、提高查询效率，并更严格的确保数据的一致性。

以下是一些 GraphQL 的优点:

  • 减少资源消耗: GraphQL 允许客户端一次请求获取所有相关联的数据，减少了网络流量和服务器消耗。
  • 精准数据: GraphQL 允许客户端指定其期望的资料，而不会包含任何不必要的信息。
  • 适应性: GraphQL 是一种灵活的协议，易于构建满足各种不同编程语言、数据库和 Web 应用程序架构的特定应用场景的端点，也可与其他协议相互集成。

通常情况下，GraphQL 不能完全替代 Restful API。在某些情况下，如非结构化搜索、排序和分页，Restful API 可能仍然是首选。此外，当与遗留代码、数据库或其他数据集成时，GraphQL 可作为一种服务的中间件。

以下是 GraphQL 集成 Restful API 的最佳实践:

1. 确定使用 GraphQL 的最佳场景

确定标准场景，使用 Restful API 或 GraphQL 的优点，以确保最佳使用。

2. 定义 GraphQL schema

定义清晰的 GraphQL schema 非常重要，它会将类型、字段、参数和查询一致地描述为 GraphQL API 的入口。

3. 集成方法

选择可以将 REST 和 GraphQL API 编写为一个 API 网关的工具。这些工具可确保所有请求均经过网关，从而减轻了前端需要理解实际 API 的负担。因此，这样整个应用程序和生态系统可以更轻松地缓解潜在的重构问题。

4. 分离数据处理逻辑

GraphQL schema 剥离了逻辑层，注重于功能的暴露，RPC 的请求-响应借口，有一个好的实现方式就是将数据处理逻辑与 GraphQL schema 分离。

示例代码

使用 GraphQL 查询 Github REST API：

----- ------------------ -------- -
  ----------- ---------- -
    ----
    -----
    --------
    ------------ -
      ----------
      ----- -
        ----
        -----------
      -
    -
  -
-

总结

GraphQL 在许多领域都有着强大的表现，尤其是在减少网络资源使用、减少网络性能问题和提高代码可维护性方面。但是，为了将其用于现实世界的场景，可能需要与常规的 RESTful API 一起使用。在合理的情况下，根据这些最佳实践，将 GraphQL 集成到 Restful API 中，可以带来卓越的结果，并取悦那些寻求适度性能增强的客户端。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/65360dd67d4982a6ebde3231

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

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

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

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

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

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

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

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

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

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

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

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

    2 个月前
  • Redis 处理高并发的策略

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

    2 个月前
  • 响应式设计中的图片适配问题解决方案

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

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

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

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

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

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

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

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

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

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

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

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

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

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

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

    2 个月前
  • 如何在 Chai 中验证 Promise.all

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

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

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

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

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

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

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

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

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

    2 个月前

相关推荐