使用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
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...