這篇就不以引述的方式回覆了,因為算是對
後續其他人不論在推文中或是回文中的內容
回覆,另外也是針對我自己在前一篇文章中
沒有提到的部分進行說明。
我不知道這裡有多少人上過 jserv的課,如
果有的話,他會頻頻強調不要「舉燭」。從
推文和回文中可以看到,其實不論是發文者
還是回答者,似乎並沒有很正視這個問題…
…
回到最一開始的問題:
「API 沒資料要回傳 200 還是 404?」
‧什麼樣的 API 呢?
‧什麼樣的場景下設計的呢?
‧什麼樣的狀況叫做沒資料?
‧有沒有基於什麼規範或風格?
‧調用的人是誰?
‧你怎麼想的呢?
如果沒有敘述清楚,要人怎麼回答呢?我想
分享一下兩段文字:
你真的想要得到的答案是這樣的嗎?
「公司前輩這樣做就這樣做啦!」
「為了方便,問就是 404 一把梭!」
這樣可以得到什麼成長嗎?你認為去有規模
的公司面試問到這樣的問題時,用這樣的回
答可以拿到 Strong Hire?老實說,這樣的
提問方式和不明就理的回答方式,只會讓社
群的風氣變得越來越糟。
雖然在前一篇文章中以及推文中,我主要都
以 REST 風格的敘述為主,但那個前提是我
認為那樣的問題敘述下,原 po 的問題是在
下述兩種不同情境下,採用 REST 風格而有
所誤解:
---
上述沒有資料的情形會有兩種:
---
但這並不代表實際開發就只有 REST 這一種
以資源為導向的風格,還有 RPC這種以方法
為導向的風格,比如早期可以見到 SOAP 的
身影,近期為了更好地適應某些場景以及發
揮 HTTP2 的優勢,還可以選擇 GraphQL 或
是 gRPC 。如果是區塊鏈的開發者,應該更
常透過 JSON-RPC 協議讀取數據。
比如以登入、搜尋等業務,就不是很好將這
兩個操作抽象為資源,並以 REST 實作。當
然要實作也並無不可,比如常見地將登入行
為改以 session 資源的創建、查詢與刪除…
這很要求開發者的抽象能力,並且對於複雜
業務來說侷限性很大;或者當我只需要文章
的標題與發表時間,以 REST 實作就會拿取
冗贅的資料。
當然,他們都各有優缺,也需要開發人員去
做取捨的。我建議拿上述關鍵字去搜一下差
異,包含 payload和調用方法等;想再了解
更多可以參考各個團隊的技術文章,我會整
裡幾篇放在最後的參考資料中。
後面的回覆中,有板友提及了傾向於使用特
定狀態碼是為了方便前端介接;也有板友提
及企業內部設備會攔截特定狀態碼。這些的
確都是實務上的限制與考量,為了讓開發順
暢必須要溝通與協調的,有時候為了時程和
和外部限制(比如客戶其實沒這麼聰明又要
求很多),當然是以能跑為第一前提……
不過這點其實我想稍微糾正一下,但必須先
說這不是所有團隊都適用,就是「不能只有
自己爽」這件事情,有時候還請三思一下是
誰在自己爽。
---
前提狀況如下:
‧以 REST 風格設計
‧接口 [GET] /users/<USERNAME>
‧<USERNAME> 不存在時返回 200 而非 404
好的,前端可以快速知道今天是後端的接口
壞掉還是正常;但是出問題時,後端要怎麼
判斷是不是參數錯誤呢? DevOps/SRE 負責
監控狀態,然後一片都 200看起來很正常,
但是使用者說資料都空的,怎麼排查?
透過正確的 HTTP Status Code 可以很快地
讓後端和 DevOps/SRE 定位原因,如果都是
200 的話,需要每一個狀態都打開查看內容
才能判斷,這真的是個好方式嗎?
在後端看來,他依照 REST 風格和 HTTP 規
範設計,是他為了自己爽嗎?
---
即使進到 exception也能夠根據狀態碼再去
處理,而狀態碼 404 也能夠攜帶 body而不
是就沒有了內容;至於前端的請求函數庫,
以 axios 來說可以自定義 validateStatus
調整 reject 的範圍吧?
今天前端會呼叫 API有八成的狀況是採取了
AJAX 方式,獲取資料於頁面上渲染,如果
能夠接受圖片、影片也是以 URI的方式鑲嵌
在你的 HTML 中,實際上被渲染出來也是由
瀏覽器對 URI發送請求獲取資源,取得後再
渲染在頁面上,圖片網址錯誤無法訪問時,
對 Nginx/Apache 來說也是返回 404 呀!
如果是 JSON 返回一項資源,比如文章內容
或使用者資訊時,這時候網址錯誤時返回同
樣的 404為什麼就這麼難以接受呢?
> 但是 /posts/256 卻 404
> 權限不夠或是真的沒有這篇文章
> 回去檢查為什麼 /users/posts 吐出 256
(抱歉上述是以網頁應用程式為敘述,我知
道對於移動端開發來說,Android 跟 Swift
下的一些 HTTP 請求框架也有問題,但我不
熟,就再請熟悉的板友幫忙補充了…)
另外 REST 風格真的不善於處理混合多種資
源的狀況,交給 GraphQL 處理會爽很多…
以 GitHub 來說,訪問以下頁面:
上述兩個網址都是交由伺服器端渲染返回,
並非由 AJAX 呼叫他們自家的 REST API 獲
取資料再渲染於頁面中。以前一篇所說明的
REST 風格設計來說,此時的「頁面」就是
「資源」,分別請求的是「使用者頁面」和
「搜尋 3123sadq 的結果頁面」。
他也符合 RFC 723x 中對於狀態碼的陳述,
所以對於有資源且存在的使用者頁面返回狀
態碼 200;而對搜尋結果頁面也是 200;而
對於使用者不存在或不願顯示的私密倉庫,
就會是 404 了。
---
如果是 GitHub 對於 search 的 REST 實作
,可以參考這裡:
BASE_URL 是
你會發現:
[GET] /search
→ 404
(沒有 search 這個資源)
[GET] /search/code
→ 422
(有 search/code 這種資源,但可能參數不足)
[GET] /search/code?q=repo:octocat/Spoon-Knife+css
→ 200
(有 search/code 這種資源,而且參數正確)
[GET] /search/cars
→ 404
(沒有 /search/cars 這種資源)
---
這時候不應該以資料夾路徑的角度去看待這
個資源,上述 REST 實作時,他不是以檔案
系統的方式來呈現資源的;也不是以頁面型
態呈現資源的。
老實說,他們家的 REST API 對我來說堪稱
楷模,因為把很多資源的抽象都做得非常優
秀……但在下面這篇文章中,也坦言存在缺
點並增添了 GraphQL API:
‧API Design Guide (Google Cloud APIs)
同時考慮了 REST API 和 RPC API 設計
對於常用的 Standard Methods 多採用了
REST 風格,而 Custom Methods 多採用
RPC 風格。
‧Best Practices for Designing a
Pragmatic RESTful API
應該是多數 REST 使用者都曾經看過的最
佳實踐文章
‧訪問遠程服務(鳳凰架構)
中國一本開源的架構著作,作者是 Java
知名書籍作者,這一章節很詳細地介紹了
REST 和其優缺點
‧一把梭:REST API 全用 POST
‧A preview of the new Dropbox API v2
簡化 HTTP 使用多採 POST 請求,並簡化
錯誤代碼的使用,採 RPC-Style 設計
還是要再說一次,在新創團隊和開發資源有
限的小公司中,上面提到的東西都不一定適
用……
不可能期待一間只有三人的新創還要搞上各
種測試跟各種優化還要部署 CI/CD 吧? 但
沒辦法去到這些公司體驗文化的話,從書上
和這些大廠的技術文章來吸收跟思考,是可
以做的(當然,他們內部也可能有例外跟分
歧)
說真的這個問題可以展開來說的東西太多了
,包括瀏覽器在輸入一個網址後會經歷哪些
過程和行為,還有網頁前後端的開發…今天
你是不是走前後端分離架構;如果純粹由伺
服器渲染,還要再分中間有沒有微服務或中
間件處理,或者後端直接訪問資料庫塞資料
給模板返回就好;是否一定要在 HTTP 協議
實現你的 API?甚至是前面有人提到的狀態
碼進異常,如果前端後端都不想要修改,有
沒有什麼處理的方式?
前陣子那串「對技術沒熱情是不是不適合這
行?」應該許多人都還記憶猶新,藉著這串
再問問文章一開始的問題:
‧如果是 Junior 的開發者,那樣的發問方
式,真的能得到解答?
‧你不追問不細問,有多少人願意主動發現
你沒問出的問題?
‧沒人回答你,你就不找答案了嗎?有人回
答你,你就直接接受了嗎?
‧如果是 Senior 的開發者,對於提問時要
不要去挖掘後面的問題?要挖到什麼程度
?
--