RESTful API如何一次完成多個相依請求

剛才收到一封信，是一個有關RESTful API設計的問題。內容如下：

若目前我有三個Resource(R1,R2,R3)，執行的順序是R1->R2->R3 ，而希望能達成R1做完的結果傳給R2，再接著R2做完的結果給R3，最後R3完成再做response，而不是client先向R1 request 得到response，再接著將response結果向R2 request 得到 response，而這樣依序下去。若希望達成這樣的目的，在Restful web service的架構中，該如何建立、執行，才能達成？

因為這個問題有一定的代表性，所以在這裡回答，可能對更多人有幫助。

基本上，希望一次呼叫就能在伺服器端完成多個有前後相依性的請求，是為了節省client/server來回傳遞的成本。假設一開始我們有三種資源API：

• R1是/authors/:id，回傳結果的欄位articleIds包括作者所有文章的id
• R2是/articles/:id，回傳結果的欄位pictureIds包括文章所有圖片的id
• R3是/pictures/:id，回傳結果的欄位url為圖片網址

現在，假設我們想要得到某位作者任一篇文章的任一張圖片的網址（實務上會有更複雜的條件需求，在此省略以簡化討論）。直覺的做法，就是依序執行R1->R2->R3，分三次送request。

若是希望一次request/response就得到結果，我能想到的，至少有兩種解法：第一種比較通用，但不太符合RESTful API的精神；第二種要針對需求個別設計API，沒有通用性，但比較符合RESTful API精神。

1. 通用性的多請求Utility API

第一種做法，就是自己開一個multi-request API，比如就叫/multi-request，然後自己訂一些規則讓request body可以包含multiple requests，例如：

{
  "requests": [
    {"method": "GET", "uri": "/authors/1001"},
    {"method": "GET", "uri": "/articles/${responses[0].articleIds[0]}"},
    {"method": "GET", "uri": "/pictures/${responses[1].pictureIds[0]}"}
  ],
  "response": {
    "url": "${responses[2].url}"
  }
}

然後假設這個multi-request API在執行的時候，會正確替換request body中的${...} pattern。（這個語法是我隨意編的，只是為了討論舉例方便。）

2. 擴展Resource API的回傳內容格式定義

第二種做法，是針對常用的use case，擴展Resource API回傳內容。例如我們假設以下這個request，會在server端擴展articles資源，在回傳結果帶articles欄位，其欄位內容為該作者某一篇文章：

GET /authors/1001;expand:articles,limit:1

而以下這個request，會在server端將擴展後的articles資源裡的pictures資源再進一步擴展，在回傳結果的articles欄位中，帶pictures欄位，其欄位內容為該文章的某一張圖片：

GET /authors/1001;expand:articles,limit:1;expand:pictures,limit:1

除了用分號，也可以用一般的query string ?...&...。（這個語法也是我隨意編的，只是為了討論舉例。）真正設計API的時候，應該考慮現在及將來各種可能的use case，做出合理且具擴展性的設計決定。

希望以上的說明，有回答到問題。