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

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

說到驗證,那就需要做三件事: 定義驗證規則 按驗證規則進行檢查 報告驗證的錯誤。在把錯誤報告給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內置了對這個標準的支持,後續視頻教程中可以看到。 


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

-Advertisement-
Play Games
更多相關文章
  • 單文件上傳前端頁面 <!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)中也已經列出了原因。 創建控制台應用 打開命令提示符,創建 ...
一周排行
    -Advertisement-
    Play Games
  • Dapr Outbox 是1.12中的功能。 本文只介紹Dapr Outbox 執行流程,Dapr Outbox基本用法請閱讀官方文檔 。本文中appID=order-processor,topic=orders 本文前提知識:熟悉Dapr狀態管理、Dapr發佈訂閱和Outbox 模式。 Outbo ...
  • 引言 在前幾章我們深度講解了單元測試和集成測試的基礎知識,這一章我們來講解一下代碼覆蓋率,代碼覆蓋率是單元測試運行的度量值,覆蓋率通常以百分比表示,用於衡量代碼被測試覆蓋的程度,幫助開發人員評估測試用例的質量和代碼的健壯性。常見的覆蓋率包括語句覆蓋率(Line Coverage)、分支覆蓋率(Bra ...
  • 前言 本文介紹瞭如何使用S7.NET庫實現對西門子PLC DB塊數據的讀寫,記錄了使用電腦模擬,模擬PLC,自至完成測試的詳細流程,並重點介紹了在這個過程中的易錯點,供參考。 用到的軟體: 1.Windows環境下鏈路層網路訪問的行業標準工具(WinPcap_4_1_3.exe)下載鏈接:http ...
  • 從依賴倒置原則(Dependency Inversion Principle, DIP)到控制反轉(Inversion of Control, IoC)再到依賴註入(Dependency Injection, DI)的演進過程,我們可以理解為一種逐步抽象和解耦的設計思想。這種思想在C#等面向對象的編 ...
  • 關於Python中的私有屬性和私有方法 Python對於類的成員沒有嚴格的訪問控制限制,這與其他面相對對象語言有區別。關於私有屬性和私有方法,有如下要點: 1、通常我們約定,兩個下劃線開頭的屬性是私有的(private)。其他為公共的(public); 2、類內部可以訪問私有屬性(方法); 3、類外 ...
  • C++ 訪問說明符 訪問說明符是 C++ 中控制類成員(屬性和方法)可訪問性的關鍵字。它們用於封裝類數據並保護其免受意外修改或濫用。 三種訪問說明符: public:允許從類外部的任何地方訪問成員。 private:僅允許在類內部訪問成員。 protected:允許在類內部及其派生類中訪問成員。 示 ...
  • 寫這個隨筆說一下C++的static_cast和dynamic_cast用在子類與父類的指針轉換時的一些事宜。首先,【static_cast,dynamic_cast】【父類指針,子類指針】,兩兩一組,共有4種組合:用 static_cast 父類轉子類、用 static_cast 子類轉父類、使用 ...
  • /******************************************************************************************************** * * * 設計雙向鏈表的介面 * * * * Copyright (c) 2023-2 ...
  • 相信接觸過spring做開發的小伙伴們一定使用過@ComponentScan註解 @ComponentScan("com.wangm.lifecycle") public class AppConfig { } @ComponentScan指定basePackage,將包下的類按照一定規則註冊成Be ...
  • 操作系統 :CentOS 7.6_x64 opensips版本: 2.4.9 python版本:2.7.5 python作為腳本語言,使用起來很方便,查了下opensips的文檔,支持使用python腳本寫邏輯代碼。今天整理下CentOS7環境下opensips2.4.9的python模塊筆記及使用 ...