刪除：雖然刪除操作通常沒有Payload，但一些API希望在請求正文中添加額外的刪除相關數據。

HTTP請求和響應Payload JSON示例

HTTP請求消息示例：

帶有JSON Payload的HTTP請求消息通常結構為：

• 請求行，包括HTTP方法、請求URI和HTTP版本。
• 提供有關請求的元信息的標題。
• 指示標題結尾的空白行。
• 消息主體，其中包含JSON有效負載。

讓我們來舉個例子。想象一下，您正在開發(fā)一個RESTful API來管理圖書集合，并且您想在集合中添加一本新圖書。

POST /api/books HTTP/1.1

Host: www.example.com

User-Agent: Mozilla/5.0

Accept: application/json

Content-Type: application/json

Content-Length: 112



{

 "title": "The Great Gatsby",

 "author": "F. Scott Fitzgerald",

 "year": 1925,

 "genre": "Fiction"

}

解釋：

請求行：

• POST是HTTP方法，表示我們要創(chuàng)建一個新資源。
• /api/books是請求URI，指定我們目標的端點。
• HTTP/1.1是HTTP版本。

標題：

• 主機：指定服務器的域名。
• 用戶代理：指示客戶端的軟件（例如，網絡瀏覽器或其他客戶端）。
• 接受：告訴服務器客戶端在響應中期望的數據類型。
• 內容類型：指定發(fā)送到服務器的數據的媒體類型，在這種情況下是application/json。
• Content-Length：表示請求主體的長度。

空白行：這將標題與正文分開。

消息正文：包含代表書籍詳細信息的JSON有效負載。

這是一個基本的例子。在現實世界的場景中，可能會有額外的標頭，如用于身份驗證目的的授權，或根據API的要求出現其他復雜性。

HTTP響應消息示例：

讓我們考慮一個場景來延續(xù)上一本書的例子。假設服務器處理了添加新書的請求，現在想要向客戶端返回確認。

HTTP響應消息示例：

HTTP/1.1 201 Created

Date: Mon, 15 Aug 2023 12:30:00 GMT

Server: Apache/2.4.1 (Unix)

Content-Type: application/json

Content-Length: 150



{

 "id": 12345,

 "title": "The Great Gatsby",

 "author": "F. Scott Fitzgerald",

 "year": 1925,

 "genre": "Fiction",

 "message": "Book successfully added!"

}

解釋：

狀態(tài)線：

• HTTP/1.1：HTTP版本。
• 201已創(chuàng)建：這是狀態(tài)代碼及其相關消息。201狀態(tài)表示請求已得到滿足，從而創(chuàng)建了新資源。

標題：

• 日期：發(fā)送消息的日期和時間。
• 服務器：有關服務器用于處理請求的軟件的信息。
• 內容類型：指定返回數據的媒體類型，在本例中，application/json。
• 內容長度：表示響應主體的長度。

空白行：這將標題與正文分開。

消息正文：包含JSON Payload，在本例中，該Payload提供了已添加書籍的詳細信息以及確認成功添加的消息。

同樣，這是一個簡單的例子。根據API和應用程序的需求，現實世界的場景可能會有額外的標頭或復雜性。

HTTP請求和響應Payload XML示例

HTTP請求XML Payload示例

消費者意味著客戶端應用程序有責任準備和發(fā)送HTTP請求消息，如下所示：

POST /SpringBootREST/customers HTTP/1.1

Accept: application/xml

Content-Type: application/xml

Content-Length: 196

User-Agent: Java/1.7.0_25

Host: 127.0.0.1:7000

Connection: keep-alive



 0 

 Ramesh 

 ramesh@gmail.com 

從上述HTTP請求中，Payload是指HTTP請求消息中的正文。它是可選的，取決于HTTP方法名稱，即

• 在GET HTTP方法的情況下，HTTP請求消息沒有正文。
• 在POST HTTP方法的情況下，帶有正文的HTTP請求消息

上述HTTP請求消息中的“內容類型”標頭名稱用于表示HTTP請求消息中的Payload格式，Payload格式為XML。

HTTP請求消息中的“接受”標頭名稱用于表示HTTP響應消息中的預期Payload格式，Payload格式為XML。

Http響應XML Payload示例

業(yè)務組件（由服務提供商開發(fā)）有責任準備和發(fā)送HTTP響應消息，如下所示：

HTTP/1.1 200 OK

Content-Type: application/xml

Server: Apache-Coyote/1.1

Transfer-Encoding: chunked

Date: Mon, 10 Nov 2019 09:45:34 GMT



 1

 Ramesh

 ramesh@gmail.com

HTTP響應消息包含任何一個HTTP狀態(tài)代碼，范圍在100到599之間：

信息：1xx

成功：2xx

重定向：3xx

客戶端錯誤：4xx

服務器端錯誤：5xx

> 在REST API上閱讀有關HTTP狀態(tài)代碼的更多信息__-HTTP狀態(tài)代碼__

從上述響應消息中，有效負載是指HTTP響應消息中的正文，有效負載為XML格式。

參考資料

英文原文: What is Payload in REST API?