緣起
事情是這樣的吨掌，我在知乎受到邀請(qǐng)回答一個(gè)問(wèn)題思犁，主要是問(wèn) ID 找不到到底要不要用 Status 404 激蹲。我回答的還是比較早的棉磨，那時(shí)候只有一兩個(gè)回答。我本來(lái)以為這是沒(méi)啥爭(zhēng)議的策泣，在一個(gè)學(xué)術(shù)的地方討論學(xué)術(shù)問(wèn)題衙傀，當(dāng)然是要遵守規(guī)范了，結(jié)果過(guò)了幾個(gè)小時(shí)大跌眼鏡萨咕。自造 code 黨竟然支持率第一统抬，還好平時(shí)見(jiàn)的也很多的全 200 黨沒(méi)有受到支持，不然真的吐血了。
為什么要遵守規(guī)范
一般那種說(shuō)特殊情況特殊處理聪建，不要拘泥于規(guī)范的人钙畔，大多都是自己沒(méi)搞清楚某些知識(shí)，拿這句話當(dāng)作偷懶的借口金麸。其實(shí)一般做項(xiàng)目沒(méi)那么多特殊情況擎析。
為了更好的適應(yīng)各種庫(kù)
大部分完善的 HTTP 請(qǐng)求庫(kù)，都會(huì)依照 RFC 的規(guī)范去設(shè)計(jì)錯(cuò)誤處理的流程挥下，雖然處理方式各有不同揍魂，但一定會(huì)在文檔說(shuō)明錯(cuò)誤處理的部分的。使用 RFC 標(biāo)準(zhǔn)能最大限度的兼容各種 HTTP 客戶端棚瘟。你說(shuō)現(xiàn)在你用的HTTP客戶端不處理 Status Code现斋，但是你沒(méi)法保證將來(lái)不重構(gòu)，重構(gòu)的時(shí)候還是不處理解取。
一般調(diào)用 api 使用 js 或者 python 的概率比較大步责，我們看看知名的庫(kù)返顺。在 js 里禀苦，最近比較流行的 axios 默認(rèn)會(huì)把 200 系列外的 code 歸到異常里。在 python 里遂鹊，最流行的 http client 是 requests 振乏，它更為詳盡的預(yù)處理了 status code 。
為了開(kāi)發(fā)者更好上手
另外在管理團(tuán)隊(duì)的方面秉扑，我們的原則是盡量的減少一個(gè)項(xiàng)目的“規(guī)范”慧邮，這樣才能更容易去遵守。能用標(biāo)準(zhǔn)的地方舟陆，一定不要自己定一個(gè)更復(fù)雜的規(guī)則误澳。無(wú)論是服務(wù)端的維護(hù)者還是 API 的消費(fèi)者是會(huì)換人流動(dòng)的，每個(gè)進(jìn)入項(xiàng)目的人熟悉一大堆無(wú)謂的自定義項(xiàng)目規(guī)范都要成本秦躯。
更簡(jiǎn)單的辦法是參考大廠
其實(shí)給項(xiàng)目定規(guī)范忆谓，最不靠譜的是自己拍腦袋，稍好一點(diǎn)的是去知乎或論壇問(wèn)踱承，更好一點(diǎn)的是去 google 搜倡缠，最簡(jiǎn)單的是直接去看大廠的產(chǎn)品或者規(guī)范啊。 API 本來(lái)就是個(gè)公開(kāi)暴露的東西茎活，還有比這更好找參考的嗎昙沦？我們來(lái)看看：
- Google 遵守規(guī)范
- Github 遵守規(guī)范
- Microsoft 遵守規(guī)范 順便說(shuō)一句，微軟的 API 規(guī)范真的很具有指導(dǎo)意義载荔。
- Twitter 遵守規(guī)范
- 阿里云 遵守規(guī)范
- 騰訊云 不遵守規(guī)范 全部 200 事實(shí)上騰訊的技術(shù)比較混亂盾饮，每個(gè)項(xiàng)目都不一樣。但最新要執(zhí)行的統(tǒng)一規(guī)范是全部 返回 200 用返回值中的錯(cuò)誤碼表明錯(cuò)誤。
- 百度云 遵守規(guī)范
我的建議
很多人也許用著很簡(jiǎn)陋的 Web 框架丘损，導(dǎo)致誤以為返回了錯(cuò)誤碼芍碧，就不能返回 Response Body 了。其實(shí)你返回 204 外的任何 Status Code号俐，最好都伴隨著返回 Body 泌豆。
在項(xiàng)目規(guī)范里，可以規(guī)定 Status Code 遵照 RFC 標(biāo)準(zhǔn)吏饿，或者選定一個(gè)集合出來(lái)踪危，把一些不常用的去掉。然后如果不是200系列的代碼猪落，必須伴隨著這樣的一個(gè)錯(cuò)誤結(jié)構(gòu)：
{
"error": "UserNotFound",
"message": "該用戶沒(méi)有找到"
}
這樣錯(cuò)誤分為了三層結(jié)構(gòu)贞远，第一層是 Status Code，使用者能大概知道是什么問(wèn)題笨忌。第二層Error 是一個(gè) Key 使用約定好的無(wú)空格的英文蓝仲，給使用者做判斷用，使用者可以根據(jù) Key 自定義接下來(lái)的操作官疲。第三層是 message 袱结，有些 Key 使用者可以決定直接把 Message 顯示個(gè)終端客戶。
如果是微服務(wù)項(xiàng)目途凫，需要要求每個(gè)服務(wù)不管用什么語(yǔ)言垢夹，都要把錯(cuò)誤統(tǒng)一成這個(gè)樣子。如果開(kāi)發(fā)者告訴你框架不支持维费，那這一定不是個(gè)好框架果元，改重構(gòu)了。好的框架不僅能讓你自定義錯(cuò)誤內(nèi)容犀盟，還能做到所謂的“框架自己出錯(cuò)的返回”也由你自定義而晒。比如路由沒(méi)有找到之類的。
最后
我實(shí)在不明白為什么一個(gè)最扯淡的答案阅畴，要自造一個(gè) 600 的 status code 倡怎，可以得票第一。知乎用戶到底有沒(méi)有一點(diǎn)獨(dú)立的判斷精神啊恶阴，只要裝的一本正經(jīng)诈胜，再擺出來(lái)一點(diǎn)資歷，哪怕是胡說(shuō)八道冯事，大家也紛紛點(diǎn)贊焦匈。也許真的不適合在知乎去回答技術(shù)問(wèn)題了。
