RESTful API 设计中的 Hypermedia 驱动

RESTful API 很流行，因为它是一种简单的架构模式，能够同时提供可伸缩性、可维护性、可重用性和安全性。但是，RESTful API 设计不仅仅是创建一个 URL，发送一个 HTTP 请求并接收一个 HTTP 响应。实际上，RESTful API 设计是一门学问，需要考虑多个方面。其中之一是 Hypermedia 驱动的设计。

什么是 Hypermedia 驱动

Hypermedia 驱动是与 RESTful API 设计相关的一个概念。它是指 API 的响应中包含了控制和数据。在 RESTful API 中，控制和数据是分离的。数据由资源表示形式表示，控制由链接表示。而 Hypermedia 驱动的设计则是包含了控制和数据，它们一起构成一个有意义的信息。

Hypermedia 驱动的设计允许客户端通过阅读响应中的链接和资源表示，发现和交互服务中的资源。这个功能又被称为“发现服务”（Discoverability）。发现服务是 RESTful API 唯一一种与传统网站相同的功能。通过发现服务，客户端可以自己构建出服务点提供的 CRUD（Create，Read，Update 和 Delete）操作。

Hypermedia 取决于语义准确的、自解释的链接（比如 API 的链接，uri），而不局限于 Web 的 URI 形式或超链接风格。这样一来，可以通过简单的链接和状态，来让客户端进行打破改动和语义的基本操作。

Hypermedia 驱动的好处

使用 Hypermedia 驱动的 API 和普通的 API 相比，有以下好处：

  1. 可维护性更高

由于每个资源都被定义为一个独立的状态，所以很容易通过 API 更新和修改这些资源，而不会破坏整个系统。

  1. 可扩展性更高

Hypermedia 驱动的设计可以允许你添加新的资源表示形式、新的链接，同时不破坏现有的 API。

  1. 可重用性更高

由于 API 的相互依赖性较小，因此它们可以被用于不同的应用程序中，而不需要修改现有的代码。

  1. 可测试性更高

使用 Hypermedia 驱动的 API 可以帮助您在测试期间更好地组织和维护测试数据。

如何设计 Hypermedia 驱动的 RESTful API

Hypermedia 驱动的 RESTful API 应该遵循以下规则：

  1. API 响应应该包含有意义的链接和其他元数据，以标识相关资源的位置。

  2. API 在响应中应该包含适当的资源表示形式，以便客户端可以理解 API 的逻辑。

  3. API 响应应该包含一组可用于执行下一步操作的链接。这些链接应该是语义正确的，并且应该明确指示下一步要采取哪些措施。

  4. API 应该通过提供多种资源表示形式的支持，来支持客户端的不同需求。

  5. API 应该支持 HATEOAS（Hypermedia as the Engine of Application State）约束，以确保客户端可以自己从 API 中发现服务。

  6. API 应该对错误响应进行恰当的处理和标识。

API 设计示例代码

下面是一个 Hypermedia 驱动的 RESTful API 的示例：

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

在这个例子中，links 数组包含了三个链接，self 表示当前页面，next 表示下一页，search 表示可以搜索数据的链接。data 数组包含了两个数据对象。

总结

Hypermedia 驱动的 RESTful API 表示 API 网络设计的未来。它是一个非常强大的设计工具，能帮助你创建高度可维护、高度扩展和易于测试的 API。设计和实现一个良好的 Hypermedia 驱动的 RESTful API 需要投入时间和精力，但是它将会改变你的整个 API 设计理念。

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

阅读全文

猜你喜欢

  • 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 个月前

相关推荐

    暂无文章