使用ASP.NET Core 3.x 構建 RESTful API - 3.4 內容協商

来源:https://www.cnblogs.com/cgzl/archive/2019/12/16/12040892.html
-Advertisement-
Play Games

現在,當談論起 RESTful Web API 的時候,人們總會想到 JSON。但是實際上,JSON 和 RESTful API 沒有半毛錢關係,只不過 JSON 恰好是RESTful API 結果的表述格式。也就是說 RESTful API 還可以使用其它的表述格式,例如 xml 或私有的格式。這 ...


現在,當談論起 RESTful Web API 的時候,人們總會想到 JSON。但是實際上,JSON  RESTful API 沒有半毛錢關係,只不過 JSON 恰好是RESTful API 結果的表述格式。也就是說 RESTful API 還可以使用其它的表述格式,例如 xml 或私有的格式。這也就意味著,我們需要讓 RESTful API 知道我們想要返回的格式。而這就是HTTP請求和響應的核心內容之一: 

 

Content Negotiation 內容協商 

內容協商是這樣一個過程:針對一個響應,當有多種表述格式可用的時候,選取最佳的一個表述。 

 

當我們的RESTful API只面向一個API消費者的時候,也許只使用 JSON 一種格式是沒有什麼問題的。但是如果需要面向各種形式的多個API消費者,那麼很有可能少數API消費者無法很好的解析JSON,它們可能更習慣於xml或者其它格式。 

 

那麼如何解決這個問題呢? 

HTTP請求的 Accept Header 就是用來解決這個問題的,API的消費者在發送請求的時候,在Accept Header 裡面填寫好 Media Type(媒體類型),例如 application/json 或者 application/xml等等。 

如果請求里填寫的是 application/json,那麼RESTful API返迴響應的表述格式就應該是 json 

 

而如果請求沒有填寫 Accept Header,那麼 RESTful API 只好使用它的預設格式進行響應了。 

如果在 Accept Header 裡面填寫的格式不被 RESTful API 所支持,那麼倒是也可以返回預設的格式,但還是要儘量避免這種情況的出現,其實針對這種情況最好的辦法是返回 406Not Acceptable 狀態碼,表示 API消費者請求的媒體類型是不可接受的,無法將其作為響應的格式。 

 

綜上,Accept Header 指的是輸出格式。 

 ASP.NET Core 裡面對應的就是 Output Formatters 

 

而用於指定輸入格式的 Header Content-Type,在 ASP.NET Core 裡面對應的就是 Input formatter 

例如 POST 請求的 body 就需要通過指定 Content-Type 來進行標識,這個 Header 可以看作是自描述性這個約束的一部分(每個消息必須包含足夠的信息來知道如何對它進行處理)。 

 


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

-Advertisement-
Play Games
更多相關文章
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 時間如流水,只能流去不流回! 點贊再看,養成習慣,這是您給我創作的動力! 本文 Dotnet9 https://dotnet9.com 已收錄,站長樂於分享dotnet相關技術,比如Winform、WPF、ASP.NET Core等,亦有C++桌面相關的Qt Quick和Qt Widgets等,只分 ...
  • 一、非同步方法返回類型 只能返回3種類型(void、Task和Task<T>)。 1.1、void返回類型:調用方法執行非同步方法,但又不需要做進一步的交互。 class Program { static void Main(string[] args) { #region async & await入 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...