RESTful API ​

RESTful API（Representational State Transfer API）是一种基于REST架构风格的应用程序接口设计方法，广泛用于Web服务和系统之间的数据交换。REST由Roy Fielding在2000年的博士论文中首次提出，强调无状态性、客户端-服务器分离、统一接口、可缓存性等原则。RESTful API的核心是通过HTTP协议进行资源的创建、读取、更新和删除操作（CRUD）。

RESTful API 的特点 ​

  • 无状态性：每个请求都包含了所有必要的信息（如身份验证信息），服务器不会在请求之间保留客户端的状态。
  • 客户端-服务器架构：客户端负责用户界面和用户体验，服务器负责数据存储和业务逻辑，二者相互独立。
  • 统一接口：RESTful API使用标准的HTTP动词（GET、POST、PUT、DELETE等）进行操作，接口设计规范一致，易于理解和使用。
  • 可缓存性：响应数据可以被标记为可缓存，以提高性能和减少服务器负载。
  • 分层系统：通过中间层（如负载均衡器、代理服务器）提升系统的可伸缩性和安全性。
  • 按需编码：服务器可以将代码或脚本发送到客户端执行，以增强客户端功能。

HTTP动词 ​

  • GET：用于读取资源，不会对服务器上的资源造成任何影响。
  • POST：用于创建新资源或提交数据，服务器处理请求后创建新资源。
  • PUT：用于更新现有资源，将客户端提供的数据覆盖服务器上的资源。
  • DELETE：用于删除服务器上的资源。
  • PATCH：用于部分更新资源，改变资源的部分内容。

URL设计 ​

RESTful API使用统一资源标识符（URI）来表示资源，每个资源有一个唯一的URL。资源之间的关系通过URL层级表示。

示例URL设计：

  • GET /books：获取所有图书列表。
  • GET /books/{id}：获取特定ID的图书。
  • POST /books：创建新图书。
  • PUT /books/{id}：更新特定ID的图书。
  • DELETE /books/{id}：删除特定ID的图书。

响应状态码 ​

RESTful API使用HTTP状态码来表示请求的处理结果：

  • 200 OK：请求成功，返回数据。
  • 201 Created：资源创建成功。
  • 204 No Content：请求成功，无返回内容。
  • 400 Bad Request：请求无效或格式错误。
  • 401 Unauthorized：请求未经授权。
  • 404 Not Found：请求的资源不存在。
  • 500 Internal Server Error：服务器内部错误。

示例 ​

以下是一个简单的RESTful API示例，使用Node.js和Express框架创建一个书籍管理系统。

RESTful API ​

RESTful API (Representational State Transfer API) is an application programming interface design method based on the REST architectural style, widely used for data exchange between web services and systems. REST was first introduced by Roy Fielding in his doctoral dissertation in 2000, emphasizing statelessness, client-server separation, uniform interfaces, and cacheability. The core of RESTful API is performing Create, Read, Update, and Delete (CRUD) operations on resources via the HTTP protocol.

RESTful API Characteristics ​

  • Statelessness: Each request contains all necessary information (e.g., authentication info). The server does not retain client state between requests.
  • Client-Server Architecture: The client handles the user interface and experience; the server handles data storage and business logic. Both are independent of each other.
  • Uniform Interface: RESTful API uses standard HTTP verbs (GET, POST, PUT, DELETE, etc.) for operations, with consistent interface design that is easy to understand and use.
  • Cacheability: Response data can be marked as cacheable to improve performance and reduce server load.
  • Layered System: System scalability and security are improved through intermediate layers (e.g., load balancers, proxy servers).
  • Code on Demand: Servers can send code or scripts to the client for execution to extend client functionality.

HTTP Verbs ​

  • GET: Used to read resources without affecting any server-side resources.
  • POST: Used to create new resources or submit data; the server creates a new resource after processing the request.
  • PUT: Used to update an existing resource by replacing it with the data provided by the client.
  • DELETE: Used to delete a resource on the server.
  • PATCH: Used for partial updates, modifying only part of the resource.

URL Design ​

RESTful API uses Uniform Resource Identifiers (URIs) to represent resources, with each resource having a unique URL. Relationships between resources are represented through URL hierarchy.

Example URL design:

  • GET /books: Get the list of all books.
  • GET /books/{id}: Get a specific book by ID.
  • POST /books: Create a new book.
  • PUT /books/{id}: Update a specific book by ID.
  • DELETE /books/{id}: Delete a specific book by ID.

HTTP Status Codes ​

RESTful API uses HTTP status codes to indicate the result of request processing:

  • 200 OK: Request successful, data returned.
  • 201 Created: Resource created successfully.
  • 204 No Content: Request successful, no content returned.
  • 400 Bad Request: Request is invalid or malformed.
  • 401 Unauthorized: Request is not authorized.
  • 404 Not Found: Requested resource does not exist.
  • 500 Internal Server Error: Internal server error.

Example ​

Here is a simple RESTful API example that uses Node.js and the Express framework to create a book management system.