REST API 最佳实践 – REST 端点设计示例

在 Web 开发中，REST API 在确保客户端和服务器之间的顺畅通信方面发挥着重要作用。

您可以将客户端视为前端，将服务器视为后端。

客户端（前端）和服务器（后端）之间的通信通常不是超级直接的。因此，我们使用一个称为应用程序编程接口（或API）的接口来充当客户端和服务器之间的中介。

由于 API 在这种客户端-服务器通信中起着至关重要的作用，因此在设计 API 时应始终牢记最佳实践。这有助于维护它们的开发人员以及使用它们的开发人员在执行这些职责时不会遇到问题。

在本文中，我将带您了解在制作 REST API 时要遵循的 9 个最佳实践。这将帮助您制作出最好的 API，也让 API 使用者的生活更轻松。

首先，什么是 REST API？

REST 代表 具象状态转移。它是Roy Fielding在2000年创建的一种软件架构风格，用于指导Web架构的设计。

任何遵循REST设计原则的API（应用程序编程接口）都被称为RESTful。

简而言之，REST API是两台计算机通过HTTP（超文本传输协议）进行通信的媒介，其通信方式与客户端和服务器通信的方式相同。

REST API 设计最佳实践

1. 使用 JSON 作为发送和接收数据的格式

过去，接受和响应 API 请求主要是用 XML 甚至 HTML 完成的。但如今，JSON（JavaScript Object Notation）在很大程度上已成为发送和接收API数据的事实格式。

这是因为，例如，对于XML，解码和编码数据通常有点麻烦 - 因此XML不再受到框架的广泛支持。

例如，JavaScr