歸檔 – 并在 RESTful Web 服務中上傳

通常我們使用標準的數(shù)據(jù)交換格式，如 JSON 或 XML 與 REST web 服務。然而，許多 REST 服務至少有一些操作很難僅用 JSON 或 XML 來完成。例如上傳產(chǎn)品圖片、使用上傳的 CSV 文件導入數(shù)據(jù)或生成可下載的 PDF 報告。

在這篇文章中，我們關注那些通常被歸類為文件下載和上傳的操作。這有點不穩(wěn)定，因為發(fā)送簡單的 JSON 文檔也可以看作是 (JSON) 文件上傳操作。

想想你要表達的操作

一個常見的錯誤是關注操作所需的特定文件格式。相反，我們應該考慮我們想要表達的操作。文件格式僅決定用于操作的媒體類型。

例如，假設我們要設計一個 API，讓用戶將頭像圖片上傳到他們的用戶帳戶。

在這里，出于各種原因，將頭像圖像與用戶帳戶資源分開通常是一個好主意：

• 頭像圖像不太可能改變，因此它可能是緩存的一個很好的候選者。另一方面，用戶帳戶資源可能包含諸如上次登錄日期之類的經(jīng)常更改的內(nèi)容。
• 并非所有訪問用戶帳戶的客戶端都可能對頭像圖像感興趣。因此，可以節(jié)省帶寬。
• 對于客戶端來說，通常最好單獨加載圖像（想想使用 <img> 標簽的 Web 應用程序）

可以通過以下方式訪問用戶帳戶資源：

/users/<user-id>

我們可以想出一個代表頭像圖像的簡單子資源：

/users/<user-id>/avatar

上傳頭像是一個簡單的替換操作，可以通過 PUT 表示：

PUT /users/<user-id>/avatar
Content-Type: image/jpeg
 
<image data>

如果用戶想要刪除他的頭像，我們可以使用簡單的 DELETE 操作：

DELETE /users/<user-id>/avatar

當然，客戶需要一種顯示頭像的方法。因此，我們可以使用 GET 提供下載操作：

GET /users/<user-id>/avatar

返回

HTTP/1.1 200 Ok
Content-Type: image/jpeg
 
<image data>

在這個簡單的例子中，我們使用了一個帶有常見更新、刪除、獲取操作的新子資源。唯一的區(qū)別是我們使用圖像媒體類型而不是 JSON 或 XML。

讓我們看一個不同的例子。

假設我們提供了一個 API 來管理產(chǎn)品數(shù)據(jù)。我們希望通過一個選項來擴展此 API，從上傳的 CSV 文件中導入產(chǎn)品。我們應該考慮一種表達產(chǎn)品導入操作的方法，而不是考慮文件上傳。

可能最簡單的方法是將 POST 請求發(fā)送到單獨的資源：

POST /product-import
Content-Type: text/csv
 
<csv data>

或者，我們也可以將其視為產(chǎn)品的批量操作。?PATCH ?方法是一種表達對集合的批量操作的可能方式。在這種情況下，CSV 文檔描述了對產(chǎn)品集合的期望更改。

例如：

PATCH /products
Content-Type: text/csv
 
action,id,name,price
create,,Cool Gadget,3.99
create,,Nice cap,9.50
delete,42,,

此示例創(chuàng)建兩個新產(chǎn)品并刪除 id 為42的產(chǎn)品。

處理文件上傳可能需要相當長的時間。所以考慮將其設計為異步 REST 操作。

混合文件和元數(shù)據(jù)

在某些情況下，我們可能需要將額外的元數(shù)據(jù)附加到文件中。例如，假設我們有一個 API，用戶可以在其中上傳假日照片。除了實際的圖像數(shù)據(jù)，照片還可能包含描述、拍攝地點等。

在這里，我會推薦使用兩個單獨的操作，原因與上一節(jié)中關于頭像圖像的原因類似。即使這里的情況有點不同（數(shù)據(jù)直接鏈接到圖像），它通常也是更簡單的方法。

在這種情況下，我們可以首先通過發(fā)送實際圖像來創(chuàng)建照片資源：

POST /photos
Content-Type: image/jpeg
 
<image data>

作為回應，我們得到：

HTTP/1.1 201 Created
Location: /photos/123

之后，我們可以將額外的元數(shù)據(jù)附加到照片中：

當然，我們也可以反過來設計，在圖像之前發(fā)送元數(shù)據(jù)。

在 JSON 或 XML 中嵌入 Base64 編碼的文件

如果無法在單獨的請求中拆分文件內(nèi)容和元數(shù)據(jù)，我們可以使用Base64 編碼將文件嵌入到 JSON/XML 文檔中。使用 Base64 編碼，我們可以將二進制格式轉(zhuǎn)換為文本表示，該文本表示可以集成到其他基于文本的格式中，例如 JSON 或 XML。

示例請求可能如下所示：

POST /photos
Content-Type: application/json
 
{
    "width": "1280",
    "height": "920",
    "filename": "funny-cat.jpg",
    "image": "TmljZSBleGFt...cGxlIHRleHQ="
}

將媒體類型與多部分請求混合

在單個請求/響應中傳輸圖像數(shù)據(jù)和元數(shù)據(jù)的另一種可能方法是多部分媒體類型。

多部分媒體類型需要一個邊界參數(shù)，用作不同正文部分之間的分隔符。以下請求由兩個正文部分組成。第一個包含圖像，而第二個部分包含元數(shù)據(jù)。

例如:

POST /photos
Content-Type: multipart/mixed; boundary=foobar
 
--foobar
Content-Type: image/jpeg
 
<image data>
--foobar
Content-Type: application/json
 
{
    "width": "1280",
    "height": "920",
    "filename": "funny-cat.jpg"
}
--foobar--

不幸的是，多部分請求/響應通常很難處理。例如，并非每個 REST 客戶端都能夠構建這些請求，并且很難在單元測試中驗證響應。