RESTful API 的设计已经成为现代应用程序的标准。然而，许多人往往忽略其中的 HATEOAS (Hypertext As The Engine Of Application State) 设计原则，这导致了 API 的不良设计和性能问题。
在本文中，我们将讨论如何高效地使用 HATEOAS 进行 RESTful API 的设计，包括其基本原则、如何设计超媒体控制器以及如何使用优秀的工具来简化开发。
HATEOAS 的基本原则
HATEOAS 原则要求 API 返回的资源应该包含超链接，从而使客户端可以探索这些资源之间的关系。这些超链接应该采用标准的 URL 格式，并描述了资源之间的关系和可用的 HTTP 操作。
一个良好的 HATEOAS API 应该包括以下原则：
- 一切都是资源：每个资源都应该有一个唯一的 URL，并使用 HTTP 动词进行操作。
- 超媒体控制器：API 应该返回可用于探索资源之间关系的超链接。
- 自描述性消息：API 应该返回与资源相关的所有信息。
- 标准方法：API 应该使用标准的 HTTP 方法来执行操作。
- 可供选择的编码：API 应该支持多种格式的编码。
- 缓存控制：API 应该包括适当的缓存控制头，以便客户端可以缓存响应。
下面我们将详细介绍如何使用这些原则来设计高效的 RESTful API。
超媒体控制器的设计
超媒体控制器是负责为 API 提供超链接的组件，每个资源都应该由一个或多个超媒体控制器提供。超媒体控制器可以是：
- 链接：返回传统的链接格式。
- 范围：返回与资源关联的超链接集。
- 集合：返回与集合关联的超链接集。
- 表单：返回用于执行操作的 HTML 表单。
我们可以使用 Spring HATEOAS 框架来创建一个自定义的超媒体控制器。
-- -------------------- ---- -------
---------------
----------------------------
------ ----- ----------------- ------- --------------------------------- ------------------ -
------- ----- ----------------- -----------
------- ----- ------------------------ ----------
------ ----------------------------------- ----------- ------------------------ ---------- -
--------------- - -----------
-------------- - ----------
-
------------
------ ----------------- ------------------- ------- -------- -
-------------------------
----------------- -------- - ------------------------------
------ ------------------------------------------------------------------
-
--------------------
------ ----------------- ------------------ ---- --- -
------- ------- - -------------------------------------- -- --- ------------------------------
------ ------------------------------
-
-- ---
-上面的代码中，我们创建了一个 ArticleController 类，并使用 ResourceAssemblerSupport 实现超媒体控制器类。在 hypermediaAssemble() 方法中，我们使用 linkTo() 方法来构建超链接，并添加到 Resource 对象中。
我们还可以使用 LinkRelation 枚举来定义超链接的关系类型。例如，我们可以使用 LinkRelation.SELF 枚举来定义一个指向自身资源的超链接。
Link link = linkTo(methodOn(ArticleController.class).read(article.getId())).withSelfRel();
这样，我们就可以更方便地定义超链接的关系类型。
优秀的工具
除了使用 HATEOAS 设计原则和超媒体控制器外，我们还可以使用一些优秀的工具来简化开发流程。下面我们将介绍几个有用的工具。
Spring HATEOAS
Spring HATEOAS 是一个基于 Spring 框架的超媒体控制器库，提供了一组强大的工具来设计 HATEOAS API。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>Swagger
Swagger 是一个开源的 API 文档工具，可以帮助我们生成 API 文档和测试 API。
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>HAL Browser
HAL Browser 是一个包含超链接的 Web 界面，可以让我们更轻松地浏览和测试 HATEOAS API。
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-rest-hal-browser</artifactId>
</dependency>总结
在本文中，我们分享了如何使用 HATEOAS 进行 RESTful API 的设计。我们介绍了 HATEOAS 的基本原则、超媒体控制器的设计、优秀的工具以及示例代码。
如果按照这些原则和最佳实践来设计 API，我们就可以构建更为稳健和高效的 API，让应用程序更为强大和易于维护。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6450623f980a9b385b970f98