Re: [討論] API沒資料，回200還是404比較好

嗯，我想兩位的建議可以寄信向 GitHub 和
Atlassian 這兩間公司說明一下，或許可以
幫他們團隊縮減人力。

當查詢資源不存在時返回 HTTP Code 404：

[REF]

[REF]

---

在往下展開之前，我必須說下面的內容是以
RESTful API 設計風格的角度去看待，實現
上還有其他的方式可以採用。

REST = Representational State Transfer

‧網路上的資源，透過 URI 與之對應

‧資源可以有不同的表現形式，透過請求時
攜帶的 Content-Type/Accept 指定

‧透過 HTTP 協議方法轉化資源狀態

在 RESTful 架構中，每一個 URI 對應一種
資源，所以設計上會避免路徑出現動詞（動
詞用以轉化資源狀態，以 HTTP 協議的方法
來對應），而以名詞呈現；加上資料庫中存
放資料通常為資料的集合，因此多採用複數
形式（多個用戶／多篇文章／多個倉庫…）

---

以 GitHub REST API (v3) 的設計來回應推
文中提到的幾個問題，舉例來說：

[GET] /users
獲取使用者清單

[GET] /users/<USERNAME>
獲取指定使用者資訊

‧如果 USERNAME 不存在，返回 404

[GET] /users/<USERNAME>/followers
獲取指定使用者的追蹤者

‧如果 USERNAME 下沒有追蹤者
返回 200 與空陣列

---

差異在於以 REST 設計時，倘若今天你要拿
到 USERNAME 去進行請求，會假定你已經知
道要拿這個使用者下面的資料了，如果是使
用者不存在，代表是 Client 的問題，企圖
存取沒有的資源，當然是 404。

而訪問指定 USERNAME 下面的追蹤者時，是
要獲取資源清單，所以這時的空陣列就是他
的清單，只是空無一人，並不是沒有清單，
自然是 200 表示請求成功。

至於有人問說返回 404 怎麼跟 API 不存在
作區別，其實從上述的範例看的出來，今天
的 <USERNAME> 相當於是查詢用的參數，訪
問這個資源的確不存在，查詢資源的 API的
確不存在，兩件事情都成立呀！

因為此時 REST 設計要告訴你的就是「路徑
不存在，路徑又對應資源，資源不存在」

---

另外提一下推文有的一些謬誤：

‧HTTP Status Code 中的 4xx 代表客戶端
錯誤，而 5xx 才是伺服器錯誤，所以系
統錯誤更不該返回 404…

‧在 REST 中用 GET 拿資料，而 204 其實
代表的是「請求成功，但沒有 BODY」，
這個比較常用在 DELETE 操作…

---

順帶提一下，規範跟設計上是需要做取捨的
，比如 GitHub 其中有一段關於授權認證的
敘述：

「Requests that require authentication
will return 404 Not Found, instead of
403 Forbidden, in some places. This is
to prevent the accidental leakage of
private repositories to unauthorized
users.」

當沒有授權的使用者去獲取倉庫清單時，即
使是沒有權限，也必須先考慮到隱私性所以
返回 404 而不是 403 避免私有倉庫被沒有
權限的人知道：

--