REST API 的 6 条规则

REST（表述性状态转移）是 Roy Fielding 在其博士论文中创建的一种架构风格，概述了创建可扩展、高效且灵活的 Web 服务的一组约束和设计原则。 REST API （应用程序编程接口）是遵循 REST 架构的 Web 服务，主要通过 HTTP 协议进行通信。这些 API 对 URL 表示的资源进行操作，提供了访问和操作客户端和服务器之间的数据的标准化方法。 REST API 的流行可归因于其简单性、互操作性和性能。

通过遵循 REST 原则，开发人员可以创建各种客户端（例如 Web 浏览器、移动应用程序或其他系统）可以轻松使用的 Web 服务。为了确保最佳性能和可扩展性，开发人员必须了解 REST API 的六个基本规则或约束。在本文中，我们将详细讨论这些规则，并了解如何应用它们来实现有效且高效的 Web 应用程序架构。

规则 1：无状态通信

REST 架构中最重要的规则之一是客户端和服务器之间的通信必须是无状态的。这意味着从客户端到服务器的每个请求都应包含服务器执行请求的操作所需的所有信息，而不依赖于先前交互中存储的信息。无状态通信具有多项优势，使其成为 RESTful API 设计的重要组成部分：

• 可扩展性： 由于服务器不需要在请求之间维护客户端状态，因此它可以处理更多并发用户并快速适应增加的需求。
• 稳健性： 无状态请求最大限度地减少服务器故障对客户端的影响，因为无需重新创建或恢复丢失的上下文信息。客户端可以简单地重试相同的请求，而不必担心对早期交互的依赖。
• 效率： 通过避免消耗资源的状态管理，无状态通信可以更有效地使用服务器资源，从而改善 API 的延迟和性能。

为了确保 REST API 中的无状态通信，请遵循以下准则：

1. 在每个 API 请求中包含所有必要的信息，例如身份验证令牌、标识符和数据负载，以便服务器可以独立处理请求。
2. 避免在服务器上存储特定于客户端的状态；利用客户端存储来满足任何会话管理要求。
3. 最大限度地减少请求之间的依赖性，以提高容错能力并简化客户端实现。

规则 2：可缓存性和分层系统

缓存能力和分层系统是两个相互关联的概念，有助于有效和高效的 RESTful API 设计。

可缓存性

REST API 必须促进响应缓存以提高性能。通过缓存响应数据，客户端可以减少后续请求的延迟，最大限度地减少服务器的负载，并减少网络流量。支持可缓存性：

1. 在 API 响应中包含与缓存相关的 HTTP 标头，例如 Cache-Control、Expires 和 ETag。
2. 确保资源具有唯一且一致的 URL，从而减少客户端缓存中出现重复条目​​的可能性。

分层系统

分层系统架构将关注点分成不同的层，例如典型的 n 层 Web 应用程序中的用户界面、业务逻辑和数据访问层。在 REST API 中，实现分层系统可以增强缓存能力、安全性和可管理性：

1. 改进的缓存能力： 通过将缓存层与应用程序逻辑分离，开发人员可以微调缓存行为以最大限度地发挥其优势。
2. 增强的安全性： 层可以封装安全机制，从而更好地控制访问并确保良好的职责分离。
3. 更好的可管理性： 通过组织和解耦组件，分层系统简化了 API 的维护、调试和演变。设计 REST API 时，请考虑合并分层系统架构，以释放这些优势以及适当的缓存支持。

请记住评估附加层对性能的影响，并在性能、组织和可用性之间取得平衡。

规则 3：使用标准方法和统一接口

RESTful API 设计的关键方面之一是遵守统一的接口。这涉及使用一致的约定和标准 HTTP 方法来处理 API 请求。通过遵守这些标准，开发人员可以显着降低实施和维护 API 的复杂性。 REST API 应利用以下标准 HTTP 方法来执行不同的操作：

• GET ：检索资源或资源集合。
• POST ：创建新资源或提交数据进行处理。
• PUT ：通过用新数据替换现有资源来完全更新现有资源。
• PATCH ：通过特定更改部分更新资源。
• DELETE ：删除资源。

这些标准方法清楚地理解每个操作并促进客户端和服务器之间的互操作性。确保每个动作的正确方法对于可靠和一致的操作至关重要。此外，统一的界面简化了错误和状态代码处理，确保客户获得清晰一致的反馈。构建 RESTful API 时，返回准确且信息丰富的 HTTP 状态代码至关重要，例如：

• 2xx – 成功： 请求已成功接收、理解并接受。
• 3xx – 重定向： 请求必须执行进一步的操作才能完成请求。
• 4xx – 客户端错误： 请求语法错误或无法满足。
• 5xx – 服务器错误： 服务器未能满足看似有效的请求。

这些状态代码清楚地指示请求的结果，使客户端能够优雅地处理错误和成功案例。

规则 4：HATEOAS - 超媒体作为应用程序状态的引擎

HATEOAS（超媒体作为应用程序状态引擎）是 RESTful API 设计中的关键约束，确保资源通过超媒体链接互连。通过使客户端能够通过这些链接来导航 API，可以更轻松地理解和发现可用的资源和操作。在 REST API 中实施 HATEOAS 有几个好处：

• 自描述： 资源中的超媒体链接提供有意义的上下文，并指导客户与资源交互以及可以执行哪些操作。
• 更好的可发现性： 在 API 响应中包含链接使客户端能够发现相关资源和操作，而无需硬编码 URL，从而减少客户端和 API 之间的耦合。
• 改进的可扩展性： 超媒体驱动的 API 更加灵活，因为可以在不破坏现有客户端的情况下添加新资源和操作，从而使 API 随着时间的推移而发展变得更加容易。

要将 HATEOAS 合并到 REST API 中，请在资源表示中包含相关的超媒体链接，并使用标准化媒体类型来传达链接关系。例如，可以使用 _links 属性将链接嵌入到 JSON 有效负载中，如下所示：

 {
  “订单ID”：12345，
  “总金额”：99.99，
  “_链接”：{
    “自己”： {
      “href”：“https://api.example.com/orders/12345”
    },
    “顾客”： {
      “href”：“https://api.example.com/customers/54321”
    }
  }
}

通过正确实施 HATEOAS，您的 REST API 变得更加动态，允许客户探索可用资源和操作并与之交互，而无需广泛的先验知识。

规则 5：支持按需编码

按需代码是 REST API 的可选约束，使服务器能够提供应用程序逻辑以对资源执行特定操作。虽然并不总是适用，但它在某些情况下允许更大的灵活性和可扩展性。按需代码的主要好处是能够将可执行代码从服务器传输到客户端，从而允许客户端运行该代码并执行请求的操作。这可以减少客户端所需的硬编码量，并有助于扩展 API 的功能，而无需对客户端进行大量更新。按需编码的一些常见用例包括：

• 为表单中的输入字段提供客户端验证逻辑。
• 加载自定义逻辑以转换或处理从服务器检索的数据。
• 基于服务器驱动逻辑动态更新用户界面。

要实现按需编码，请考虑使用流行的客户端脚本语言，例如 JavaScript 或 TypeScript。该代码可以作为 API 响应的一部分交付、嵌入到网页中或作为外部脚本加载。虽然按需编码可以提供额外的灵活性，但它也带来了潜在的安全风险并增加了客户端实现的复杂性。因此，应在其益处大于潜在缺点的情况下谨慎使用它。

理解和应用 REST API 的六项基本规则对于开发高效、可扩展且强大的 Web 应用程序架构至关重要。遵守这些最佳实践可确保您的 API 易于使用、维护和扩展。

规则 6：清晰一致的命名约定

应用清晰一致的命名约定对于使 REST API 易于开发人员理解和导航至关重要。不一致的命名约定可能会让客户感到困惑，并增加使用 API 的学习曲线。遵守既定的规则和模式使 RESTful API 可预测，从而实现更快的开发和广泛采用。

以下是设计 REST API 命名约定时需要遵循的一些重要准则：

1. 使用资源名词： 关注您公开的资源及其关系，而不是具体的操作。使用复数名词（例如/products、/users）来表示资源集合，并避免使用动词（例如/getProducts、/createUser）。
2. 保持 URL 简单且可预测： 由客户设计直观且易于理解的 URL，使用资源层次结构来表达关系（例如 /users/{id}/orders）。

除了这些基础知识之外，还有一些确保命名约定一致的最佳实践：

1. 使用小写字母： 通过在资源名称和属性中使用小写字母，使您的 API 不区分大小写。这减少了出错的机会，并使 URL 更易于读写。
2. 在适当的时候嵌套资源： 当资源具有父子关系时，请在 URL 结构中用斜杠反映这种嵌套（例如，/users/{id}/orders）。
3. 使用连字符分隔单词： 在资源名称和属性中，使用连字符 (-) 分隔单词以提高可读性（例如，/product-categories）。
4. 避免不必要的缩写： 对资源及其属性使用清晰且具有描述性的名称。简短、模糊的名称可能会让使用 API 的开发人员感到困惑并增加学习曲线。

通过遵循这些准则，您可以创建易于理解和导航的 REST API，确保积极的开发人员体验并鼓励采用。

将RESTful API规则应用到AppMaster平台

在 AppMaster ，我们了解在构建 Web、移动和后端应用程序时遵循 REST API 设计最佳实践的重要性。我们的 无代码 平台允许客户通过遵循 REST API 的六项规则来生成高度可扩展且高效的应用程序。这使客户能够 构建强大的应用程序 并减少开发时间并消除技术债务。

以下是 RESTful API 规则在AppMaster平台中的应用方式：

1. 无状态通信： AppMaster通过确保根据客户设计生成的服务器endpoints独立于任何客户端上下文来促进无状态通信。这使得扩展 Web 服务和处理不断增加的请求变得更加容易。
2. 可缓存性和分层系统： AppMaster通过使客户端能够使用缓存机制来鼓励可缓存性和系统架构的分层方法。这会优化性能并减少服务器负载。
3. 使用标准方法和统一接口： AppMaster在生成服务器endpoints时遵循统一接口和标准HTTP方法的原则。这使得开发人员更容易理解生成的API并降低集成的复杂性。
4. HATEOAS – 超媒体作为应用程序状态的引擎： AppMaster在生成应用程序时融入了 HATEOAS 原则，确保资源通过链接互连。这使客户端能够轻松地在资源之间导航并根据需要扩展 API。
5. 支持按需代码： 通过提供 Business+ 订阅（允许客户检索已编译的应用程序）甚至可以访问源代码的企业订阅， AppMaster支持按需代码。这使客户能够根据需要在本地托管应用程序。
6. 清晰一致的命名约定： AppMaster在应用程序生成过程中提倡清晰一致的命名约定，使开发人员能够轻松理解和导航API。这有助于改善开发人员体验并缩短开发时间。

遵守 REST API 的六项规则对于创建可扩展且高效的 Web 应用程序至关重要。 AppMaster对这些最佳实践的承诺可帮助客户开发功能强大且可维护的应用程序，同时在当今竞争激烈的市场中保持优势。凭借直观且强大的no-code平台， AppMaster使企业能够简化其 应用程序开发 流程，而无需牺牲质量或性能。