REST API(也称为 RESTful API 或 RESTful Web API)是一种 应用程序编程接口 (API),它符合 具象状态传输 (REST) 架构风格的设计原则。REST API 提供了一种灵活、轻量级的方式来集成应用程序并连接微服务架构中的组件。
REST 最早是由计算机科学家 Roy Fielding 博士于 2000 年在他的博士论文中定义,它为开发人员提供了相对较高的灵活性、可扩展性和效率。出于这些原因,REST API 已成为在微服务架构中连接组件和应用程序的常用方法。
这本电子书旨在破除有关可观测性的误解,并展示其在数字世界中的作用。
阅读智能自动化指南
无论请求来自何处,对同一资源发出的所有 API 请求都应该看起来相同。REST API 应确保同一份数据(例如,用户的姓名或电子邮件地址)仅属于一个统一资源标识符 (URI)。资源不应太大,但应包含客户可能需要的每条信息。
在 REST API 设计中,客户端和服务器应用程序必须完全相互独立。客户端应用程序应该知道的唯一信息是所请求资源的 URI,它不能以任何其他方式与服务器应用程序交互。同样,除了通过 HTTP 将客户端应用程序传递到所请求的数据外,服务器应用程序不应修改客户端应用程序。
REST API 是无状态的,这意味着每个请求都需要包含处理它所需的所有信息。换言之,REST API 不需要任何服务器端会话。不允许服务器应用程序存储与客户端请求相关的任何数据。
如果可能,资源应该可以在客户端或服务器端缓存。服务器响应还需要包含有关是否允许对已交付资源进行缓存的信息。目标是提高客户端的性能,同时提高服务器端的可扩展性。
在 REST API 中,调用和响应会经过多个不同的层。根据经验,不要假定客户端和服务器应用程序直接相互连接。通信环路中可能包含多个不同的中介服务器。REST API 的设计需要确保客户端和服务器都无法判断自己是与最终应用程序还是与中介服务器通信。
REST API 通常发送静态资源,但在某些情况下,响应也可以包含可执行代码(例如 Java 小程序)。在这些情况下,代码只应按需运行。
REST API 通过 HTTP 请求进行通信,执行标准的数据库功能,如在资源中创建、读取、更新和删除记录(也称为 CRUD)。
例如,REST API 会使用 GET 请求来检索记录。POST 请求用于创建新记录。PUT 请求用于更新记录,DELETE 请求用于删除记录。所有 HTTP 方法都可以在 API 调用中使用。精心设计的 REST API 类似于在具有内置 HTTP 功能的 Web 浏览器中运行的网站。
任何特定时刻或时间戳的资源状态称为资源表示。几乎可以采用任何格式将该信息传递到客户端,包括 JavaScript 对象表示法 (JSON)、HTML、XLT、Python、PHP 或纯文本。JSON 很受欢迎,因为它既能被人类读取,也能被机器读取,而且与编程语言无关。
在 REST API 调用中,请求标头和参数也很重要,因为它们包含重要的标识信息,例如元数据、授权、统一资源标识符 (URI)、缓存、cookie 等。精心设计的 REST API 中会使用请求标头和响应标头以及传统的 HTTP 状态代码。
尽管灵活性是 REST API 设计的一大优势,但是这种灵活性同样也容易设计出不连续或性能不佳的 API。因此,专业开发人员分享了 REST API 规范的最佳实践。
OpenAPI 规范 (OAS) 建立了一个接口来描述 API,该描述方式支持任何开发人员或应用程序发现它,并完全理解其参数与能力。这些信息包括可用端点、每个端点上允许的操作、操作参数、身份验证方法等。最新版本的 OAS3 包括手动操作工具,例如 OpenAPI Generator,可以用不同的编程语言生成 API 客户端和服务器存根。
确保 REST API 的安全也要从行业最佳实践开始。使用哈希算法确保密码安全,使用 HTTPS 实现安全数据传输。类似 OAuth 2.0 的授权框架可以帮助限制第三方应用程序的权限。
使用 HTTP 标头中的时间戳,API 还可以拒绝在特定时间段后到达的任何请求。其他确保只有授权客户端才能访问 API 的方法包括参数验证和 JSON Web 令牌。