Api 最佳實踐

Created: November-22, 2018

狀態程式碼

1xx：資訊

資訊	描述	詳細描述
`100`	繼續	伺服器已收到請求標頭，客戶端應繼續傳送請求正文
`101`	切換協議	請求者已要求伺服器切換協議
`103`	檢查站	用於可恢復請求提議以恢復中止的 PUT 或 POST 請求

2xx：成功

資訊	描述	詳細描述
`200`	好	請求正常（這是成功 HTTP 請求的標準響應）
`201`	建立	請求已完成，並建立了新資源
`202`	公認	該請求已被接受處理，但處理尚未完成
`203`	非權威資訊	請求已成功處理，但返回的資訊可能來自其他來源
`204`	無內容	請求已成功處理，但未返回任何內容
`205`	重置內容	請求已成功處理，但未返回任何內容，並要求請求者重置文件檢視
`206`	部分內容	由於客戶端傳送的範圍標頭，伺服器僅提供部分資源

3xx：重定向

資訊	描述	詳細描述
`300`	多種選擇	連結列表。使用者可以選擇連結並轉到該位置。最多五個地址
`301`	永久移動	請求的頁面已移至新 URL
`302`	發現	請求的頁面已臨時移動到新 URL
`303`	見其他	請求的頁面可以在不同的 URL 下找到
`304`	沒有修改	表示自上次請求後未請求修改請求的頁面
`306`	切換代理	不再使用
`307`	臨時重定向	請求的頁面已臨時移動到新 URL
`308`	恢復不完整	用於可恢復請求提議以恢復中止的 PUT 或 POST 請求

4xx：客戶端錯誤

資訊	描述	詳細描述
`400`	錯誤的請求	由於語法錯誤，無法滿足請求
`401`	擅自	該請求是合法請求，但伺服器拒絕響應它。用於可以進行身份驗證但已失敗或尚未提供的情況
`402`	需要付款	保留供將來使用
`403`	被禁止	該請求是合法請求，但伺服器拒絕響應它
`404`	未找到	找不到請求的頁面，但將來可能會再次提供
`405`	方法不允許	使用該頁面不支援的請求方法請求頁面
`406`	不能接受的	伺服器只能生成客戶端不接受的響應
`407`	需要代理驗證	客戶端必須首先使用代理進行身份驗證
`408`	請求超時	伺服器超時等待請求
`409`	衝突	由於請求中存在衝突，無法完成請求
`410`	飄	請求的頁面不再可用
`411`	長度要求	內容長度未定義。沒有它，伺服器將不接受請求
`412`	前提條件失敗	請求中給出的前提條件由伺服器評估為 false
`413`	請求的實體太大	伺服器不接受請求，因為請求實體太大
`414`	請求 URI 太長	伺服器不接受請求，因為 URL 太長。將 POST 請求轉換為具有長查詢資訊的 GET 請求時發生
`415`	不支援的媒體型別	伺服器不接受請求，因為不支援媒體型別
`416`	請求的範圍不滿意	客戶端已請求檔案的一部分，但伺服器無法提供該部分
`417`	期望失敗	伺服器無法滿足 Expect 請求標頭欄位的要求

5xx：伺服器錯誤

資訊	描述	詳細描述
`500`	內部伺服器錯誤	一個通用錯誤訊息，在沒有更具體的訊息適合時給出
`501`	未實現	伺服器要麼不識別請求方法，要麼無法滿足請求
`502`	錯誤的閘道器	伺服器充當閘道器或代理，並從上游伺服器收到無效響應
`503`	暫停服務	伺服器當前不可用（過載或關閉）
`504`	閘道器超時	伺服器充當閘道器或代理，並未從上游伺服器收到及時響應
`505`	不支援 HTTP 版本	伺服器不支援請求中使用的 HTTP 協議版本
`511`	需要網路驗證	客戶端需要進行身份驗證才能獲得網路訪問許可權

參考： Http 程式碼