使用ASP.NET Core 3.x 构建 RESTful API - 3.3.3 ProblemDetails
當(dāng)ASP.NET Core?大約在?2.1?版本的時候,它引入了?ProblemDetails。ProblemDetails是基于?RFC7807?這個規(guī)范,目的是讓?HTTP?響應(yīng)可以攜帶錯誤的詳細(xì)信息,而不是只返回一個錯誤的狀態(tài)碼。?
在?ASP.NET Core 2.2的時候,如果Controller使用了?[ApiController]?這個屬性,那么?ProblemDetails?就是客戶端錯誤碼的標(biāo)準(zhǔn)響應(yīng)。?
例如,當(dāng)返回類型為?IActionResult?的方法返回客戶端錯誤狀態(tài)碼的時候(4xx),同時還會返回一個body,這個?body?就是?ProblemDetails。?這個結(jié)果里還會包含著一個相關(guān)的ID,使用這個ID,就可以把錯誤和相應(yīng)的請求日志關(guān)聯(lián)起來。?
?
關(guān)于ProblemDetails這個類,可以查看:官方文檔。?
?
為了使用ProblemDetails??
需要為應(yīng)用程序定義一個通用的錯誤顯示格式;?
很多時候,只返回HTTP狀態(tài)碼并不能表達(dá)和傳遞出足夠的信息。?
?
在ASP.NET Core 3.x里面,同樣也使用了?ProblemDetails。?
看一個返回404的例子:?
這是一個Get請求,但是并沒有找到該資源,返回的狀態(tài)碼是404,而響應(yīng)的body就是?ProblemDetails。?
值得注意的是,這個響應(yīng)的?Content-Type?是?application/problem+json:?
總結(jié)
以上是生活随笔為你收集整理的使用ASP.NET Core 3.x 构建 RESTful API - 3.3.3 ProblemDetails的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 你知道怎么使用DebugView查看调试
- 下一篇: (译)An introduction t