使用ASP.NET Core 3.x 構建 RESTful API - 5.1 輸入驗證

来源:https://www.cnblogs.com/cgzl/archive/2020/01/13/12189141.html

說到驗證,那就需要做三件事: 定義驗證規則 按驗證規則進行檢查 報告驗證的錯誤。在把錯誤報告給API消費者的時候,報告里並不包含到底是服務端還是API消費者引起的錯誤,這是狀態碼的工作。而通常響應的Body裡面會包含一組驗證錯誤信息,API消費者可以把這些信息展示給API消費者的用戶。 定義驗證規則 ...


說到驗證,那就需要做三件事: 

  • 定義驗證規則 

  • 按驗證規則進行檢查 

  • 報告驗證的錯誤。在把錯誤報告給API消費者的時候,報告里並不包含到底是服務端還是API消費者引起的錯誤,這是狀態碼的工作。而通常響應的Body裡面會包含一組驗證錯誤信息,API消費者可以把這些信息展示給API消費者的用戶。 

 

定義驗證規則 

想要定義驗證規則,我們可以使用ASP.NET Core內置的方式或者使用第三方庫。 

ASP.NET Core裡面,驗證規則可以通過以下的方式來進行定義: 

  • Data Annotations。例如 [Required][MaxLength]等等。 

  • 自定義Atrribute 

  • 實現IValidatableObject介面。 

 

驗證什麼? 

驗證的是輸入數據,而不是輸出數據。例如POST請求Body裡面的參數就需要進行驗證,而GET請求返迴響應裡面的內容就不需要驗證了。 

 

按驗證規則進行檢查 

ASP.NET Core 內置了一個 ModelState對象,它用來做驗證規則檢查。 

  • ModelState對象是一個Dictionary(字典),它既包含model的狀態,又包含model的綁定驗證信息。 

  • 它也包含針對每個提交的屬性值的錯誤信息的集合。每當有請求進來的時候,定義好的驗證規則就會被檢查。 

 

如果有一個規則驗證不通過的話,那麼ModelState.IsValid()方法就會返回false。而且如果傳進來的屬性的類型不正確的話,該方法也會返回false 

 

報告驗證錯誤信息 

由於驗證錯誤肯定是由客戶端引起的,所以返回的狀態碼肯定是4xx。針對驗證錯誤,具體的就是422 Unprocessable entity 這個狀態碼。 

之前也講過 422 表示伺服器理解了entityContent-Type,並且語法也正確,但是仍然無法處理所包含的結構數據。例如:語法正確,但是語義不正確。 

 

當報告驗證錯誤信息的時候,我們不僅要使用正確的狀態碼,還需要在響應的body裡面包含驗證錯誤信息。 

REST並沒有規定返回的錯誤信息的格式,但是有一個標準卻規定了此事:Validation Problem Details RFC,它定義了這樣的響應的body應該是什麼樣的。ASP.NET Core內置了對這個標準的支持,後續視頻教程中可以看到。 


您的分享是我們最大的動力!

更多相關文章
  • 單文件上傳前端頁面 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Upload A File</title> </head> <body> <form action="upload.php" method= ...
  • go微服務框架kratos學習筆記六(kratos 服務發現 discovery) [toc] 除了上次的warden直連方式外,kratos有另一個服務發現sdk : "discovery" discovery 可以先簡單理解為一個http服務、 它最簡單的發現過程可能是這樣的: 1、servic ...
  • 處理靜態文件 對於 HTML 頁面中的 css 以及 js 等靜態文件,需要使用使用 net/http 包下的以下 方法來處理 1) StripPrefix 函數 2) FileServer 函數 3) 例如: 會匹配 以 開發的路徑,當瀏覽器請求 頁面中的 s文件時, 首碼會被替換為 ,然後去 目 ...
  • 問題: 在一些特定的情況下,程式中需要用到進位之間的轉化,現在來說說十進位和十六進位的轉化。 其實java進位轉換非常的簡單。 那問什麼還要說這個問題呢? 因為在轉化的時候遇到一個問題。。。 記錄一下,防止再次發生。 一、十六進位轉十進位 1.錯誤的做法 其實對於這種寫法,部分是可以使用的(十六進位 ...
  • 今天在寫gin介面的時候,每次添加或修改個介面都需要重啟項目才能測試,感覺很麻煩。 因為beego有bee工具,bee run啟動項目fsnotify會監控文件變動,經查發現在iris項目中有個插件支持熱重啟。 使用方法如下: # 安裝rizla包 $ go get -u github.com/ka ...
  • 1. 安裝Sentry 2.在settings.py中配置 3.dsn的獲取 4.註意事項 最後,如有問題,請留言。 ...
  • 原文: "https://devblogs.microsoft.com/dotnet/configureawait faq/" .NET 在七多年前在語言和類庫添加了 。在那個時候,它像野火一樣流行,不僅遍及.NET生態系統,而且還可以以多種其他語言和框架進行複製。在利用非同步的其他語言構造,提供非同步 ...
  • 前言 在我們開發中可能需要設計一次性應用程式,這些實用程式可以利用接近原始源代碼的優勢,但可以在與主Web應用程式完全獨立的安全性上下文中啟動。具體在 [管理過程] (https://12factor.net/admin processes)中也已經列出了原因。 創建控制台應用 打開命令提示符,創建 ...
一周排行
  • C#中的DefaultView方法 簡介: 首先可建立一個表,對錶進行填充若幹條數據,代碼如下: //創建Table1 DataTable dt = new DataTable(); //對Table1添加列名,並設置列值類型 DataTable dt1 = new DataTable();//創建 ...
  • 1、運行程式報錯: FailFast: Couldn't find a valid ICU package installed on the system. 解決方法: yum install icu -y 2、程式運行後,本地可以訪問,但其他機器無法訪問,需要開放埠 firewall-cmd - ...
  • 只是一個Demo,所用有很多功能也沒有添加進去如分頁,輸入驗證,頁面也沒有進行精心佈局。 整體先來幾張圖解 ...
  • Core提供二種開發模式:Core Pages和Core MVC,今天介紹的是Core MVC。 1、創建web MVC項目 新建service/h_r.baseservice類庫文件、data/h_r.efdata類庫文件、common/h_r.common類庫文件。 引入需要的CSS文件和JS文 ...
  • 學習網址:https://docs.microsoft.com/zh-cn/visualstudio/get-started/visual-studio-ide?view=vs-2019 示範 vs2019: 變數的重命名的重構,更改該變數命名的同時,引用該變數的地方也會更改,如果該變數有被反射用到 ...
  • 1、在data裡面新建個Entity文件用於存放表映射,設計資料庫,執行如下語句 Scaffold-DbContext -Force "server=.;user=sunyong;password=1qaz!QAZ;database=hr;" Microsoft.EntityFrameworkCor ...
  • 1、發送郵件類,百度一大堆,這裡用的也是直接百度拿過來的 public static bool get_send_email(email email, string Title, string Body) { MailMessage mailMsg = new MailMessage(); mail ...
  • 1、添加用戶列表控制器,用於用戶列表顯示,登錄,增刪改查,郵件發送,下載 public userlistController(MainDbContext _db, ILogger<operatorlog> _logger, IOptions<email> sendMail) { db = _db; ...
  • 1、用戶列表頁面 @{ Layout = Layout = null;}<table id="datalistuser" class="easyui-datagrid" url="/userlist/getuserlist" toolbar="#toolbaruser" rownumbers="tr ...
  • 1、引用包 Microsoft.EntityFrameworkCore.Tools Microsoft.EntityFrameworkCore.SqlServer Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation Microsoft.AspNetCo ...