HTTP狀態碼

HTTP狀態碼會告訴API的消費者以下事情：

請求是否執行成功了
如果請求失敗了，那么誰為它負責

HTTP的狀態碼有很多，但是Web API不一定需要支持所有的狀態碼，HTTP狀態碼一共分為5個級別：

1xx，屬于資訊性的狀態碼，Web API并不使用1xx的狀態碼，
2xx，意味著請求執行的很成功，
- 200 - Ok，表示請求成功；
- 201 - Created，請求成功并創建了資源；
- 204 - No Content，請求成功，但是不應該回傳任何東西，例如洗掉操作，
3xx，用于跳轉，例如告訴搜素引擎，某個頁面的網址已經永久的改變了，絕大多數的Web API都不需要使用這類狀態碼，
4xx，客戶端錯誤：
- 400 - Bad Request，表示API消費者發送到服務器的請求是有錯誤的；
- 401 - Unauthorized，表示沒有提供授權資訊或者提供的授權資訊不正確；
- 403 - Forbidden，表示身份認證已經成功，但是已認證的用戶卻無法訪問請求的資源；
- 404 - Not Found，表示請求的資源不存在；
- 405 - Method not allowed，當嘗試發送請求到資源的時候，使用了不被支持的HTTP方法時，就會回傳405狀態碼；
- 406 - Not acceptable，這表示API消費者請求的表述格式并不被Web API所支持，并且API不會提供默認的表述格式，例如請求的媒體型別是application/xml，但是Web API僅支持application/json型別，并且API不會將application/json作為默認格式提供；
- 409 - Conflict，表示請求與服務器當前狀態沖突，通常指更新資源時發生的沖突，例如，當你編輯某個資源的時候，該資源在服務器上又進行了更新，所以你編輯的資源版本和服務器的不一致，當然有時候也用來表示你想要創建的資源在服務器上已經存在了，它就是用來處理并發問題的狀態碼，
- 415 - Unsupported media type，與406正好相反，有一些請求必須帶著資料發往服務器，這些資料都屬于特定的媒體型別，如果API不支持該媒體型別格式，415就會被回傳，
- 422 - Unprocessable entity，它是HTTP擴展協議的一部分，它說明服務器已經懂得了物體的Content Type，也就是說415狀態碼肯定不合適；此外，物體的語法也沒有問題，所以400也不合適，但是服務器仍然無法處理這個物體資料，這時就可以回傳422，所以它通常是用來表示語意上有錯誤，通常就表示物體驗證的錯誤，
5xx，服務器錯誤：

500 - Internal server error，表示服務器出現了錯誤，客戶端無能為力，只能以后再試試了，

錯誤和故障

系統時不時的會出現一些問題，這些問題可以劃分為兩類：錯誤和故障，

錯誤 Errors

錯誤通常是由API的消費者引起的，API消費者請求時傳遞的資料是不合理的，這時API就會正常的將其拒絕，例如，請求的憑證是不合理的，或者請求的引數不合理等等，

這些就是HTTP 4xx錯誤，

錯誤并不會影響API的可用性，

故障 Faults

故障是指，針對一個合理的請求，API無法回傳它的回應，換句話說就是API引起的問題，

這些是HTTP 5xx錯誤，

故障確實會對API整體的可用性造成影響，

ProblemDetails

當ASP.NET Core 大約在 2.1 版本的時候，它引入了 ProblemDetails，ProblemDetails是基于 RFC7807 這個規范，目的是讓 HTTP 回應可以攜帶錯誤的詳細資訊，而不是只回傳一個錯誤的狀態碼，

在 ASP.NET Core 2.2的時候，如果Controller使用了 [ApiController] 這個屬性，那么 ProblemDetails 就是客戶端錯誤碼的標準回應，

例如，當回傳型別為 IActionResult 的方法回傳客戶端錯誤狀態碼的時候（4xx），同時還會回傳一個body，這個 body 就是 ProblemDetails，這個結果里還會包含著一個相關的ID，使用這個ID，就可以把錯誤和相應的請求日志關聯起來，

關于ProblemDetails這個類，可以查看：官方檔案，

為了使用ProblemDetails？

需要為應用程式定義一個通用的錯誤顯示格式；
很多時候,只回傳HTTP狀態碼并不能表達和傳遞出足夠的資訊，

在ASP.NET Core 3.x里面，同樣也使用了 ProblemDetails，

看一個回傳404的例子：

這是一個Get請求，但是并沒有找到該資源，回傳的狀態碼是404，而回應的body就是 ProblemDetails，

值得注意的是，這個回應的 Content-Type 是 application/problem+json：

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/4462.html

標籤：ASP.NET

上一篇：Asp.net 學習記錄（一）使用asp.net 構建webAPI介面