.net core 雜記:WebAPI的XML請求和響應

来源:https://www.cnblogs.com/qiuguochao/archive/2019/07/03/11129357.html
-Advertisement-
Play Games

一般情況下,restfult api 進行數據返回或模型綁定,預設json格式會比較常見和方便,當然偶爾也會需要以XML格式的要求 對於返回XML,普通常見的方式就是在每個aciton方法進行諸如XmlFormatter此類的序列化處理, 而對於接收XML,則是進行一些額外的XML解析操作或反序列化 ...


一般情況下,restfult api  進行數據返回或模型綁定,預設json格式會比較常見和方便,當然偶爾也會需要以XML格式的要求

對於返回XML,普通常見的方式就是在每個aciton方法進行諸如XmlFormatter此類的序列化處理,

而對於接收XML,則是進行一些額外的XML解析操作或反序列化處理。

下麵記錄和學習較為便捷的WebAPI的XML請求和響應處理使用,不喜勿噴,有錯請指教。

.net core 版本:2.2

添加XML格式支持

1、安裝 Microsoft.AspNetCore.Mvc.Formatters.Xml NuGet 包

2、再Startup.ConfigureServices 中調用 AddXmlSerializerFormatters 來配置對 System.Xml.Serialization.XmlSerializer的 實現。

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).AddXmlSerializerFormatters();
}

響應XML數據

想再Action層面、Controller層面或全局範圍內指定特定操作響應XML格式,只需添加 [Produces] 過濾器,會自行處理成xml格式響應,無需再進行其他繁雜的處理步驟

如下指定Action方法響應XML格式:

[HttpGet("getstudent/{id}")]
[Produces("application/xml")]
public Student GetStudent(int id)
{
    var obj = new Student
    {
        Age = 12,
        Name = "123123"
    };
    return obj;
}

將直接返回如下:

 XML請求

 XML格式數據請求則使用[Consumes],若沒有該屬性,則直接識別請求頭中的Content-Type,也就是[Consumes]可以省略,只要Content-Type為xml,就能進行xml數據的模型綁定

 如下代碼:

下麵示例以XML格式請求,程式會自動解析並綁定Student模型類,返回此對象的json格式(webapi 預設返回的格式)

[HttpPost("poststudent")]
[Consumes("application/xml")]
public Student PostStudent(Student obj)
{
    return obj;
}

結果如下:

 


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

-Advertisement-
Play Games
更多相關文章
  • 單列集合框架體系 List 集合體系 主要實現類 依次為 ArrayList,LinkedList,Vector 。 List介面主要特征: 有序,可重覆,有索引,底層容量是動態擴容的。(代碼以JDK 1.8為例) ArrayList:是List介面的主要實現類,底層用數組實現: ,transien ...
  • 簡介: 使用Springboot應用,選中需要的模塊, Spring已經預設將場景配置好了,只需在配置文件中少量配置就可以運行起來 自己編寫業務代碼 自動配置原理 這個場景Springboot幫我們配置了什麼、能不能修改呢?能修改哪些配置? xxxxxAutoConfiguration :幫我們給容 ...
  • 占位符% %s (str類型占位) %d(digit,int類型占位) 案例: name = input('請輸入您的姓名:') age = input('您的年齡:') job = input('您的工作:') hobbie = input('您的愛好:') mag = ''' info of % ...
  • 項目地址: "https://github.com/PythonerKK/django generate pdf/tree/master" 這個demo實現了通過用戶輸入自己的個人信息生成一份簡歷pdf,來闡述如何使用Django的HttpResponse生成PDF的文檔。 先上效果圖: 安裝依賴庫 ...
  • 有限狀態自動機(FSM):是一種表達某一狀態到另一狀態發生轉化的數學模型。 例如:在長跑比賽開始時 我處於等待的狀態下,待裁判喊 預備 時,我就會從等待狀態轉換到預備狀態。聽到裁判的槍聲時,我就從預備狀態轉換到奔跑狀態 。這個過程就相當於有限狀態自動機。 FSM的狀態就是一個事件當前所處於的情況。 ...
  • [toc] Django 使用 markdown 插件 Python Markdown 插件 安裝 1 將 markdown 轉化為 html models templates: 此時,模板中通過 將 中的 markdown 文本轉化為 html 在前臺頁面顯示。 2 使用 markdown 編輯框 ...
  • 7.2 繼承與派生 7.21繼承 1、什麼是繼承? 繼承是一種新建類的的方式,在python中支持一個子類繼承多個父類。新建的類稱為子類或者派生類,父類又可以稱為基類或者超類,子類會”遺傳“父類的屬性。 2、為什麼要用繼承 減少代碼冗餘 3、繼承是類與類之間的關係,尋找這種關係需要先抽象再繼承 7. ...
  • 本節導航 Swagger介紹 在ASP.NET CORE 中的使用swagger   在軟體開發中,管理和測試API是一件重要而富有挑戰性的工作。在我之前的文章 "《研發團隊,請管好你的API文檔》 " 也專門闡述了通過文檔管理工具,來保證API文檔和代碼的一致性,這樣更加有助於 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...