【C#/.NET】RESTful風格的Post請求與CreateAtAction

来源:https://www.cnblogs.com/xuyd/archive/2023/07/05/17529496.html
-Advertisement-
Play Games

​BackgroundImageLayout屬性值 背景圖片重覆:BackgroundImageLayout屬性設置為Tile(預設) 背景圖片左邊顯示:BackgroundImageLayout屬性設置為None 背景圖片右邊顯示:BackgroundImageLayout屬性設置為None,同時 ...


 目錄

 

引言

實現步驟

概念介紹

創建控制器

總結


 

引言

        在構建Web應用程式時,遵循RESTful風格的API設計原則能夠使我們的系統更加靈活、可擴展和易於維護。其中,Post請求在創建資源時起重要作用。本文將介紹如何在.NET WebApi中使用CreateAtAction來實現RESTful風格的Post請求。

實現步驟

概念介紹

        創建資源的Post請求: 在RESTful架構中,使用Post請求來創建新資源。以下是一些實現RESTful風格的Post請求的技術要點:

  • 使用POST動詞發送請求;
  • 在請求的主體中發送要創建的資源的表示形式(通常使用JSON或XML);
  • 返回狀態碼201(Created),表示資源已成功創建;
  • 在響應頭中包含新資源的位置URL。

創建控制器

創建一個控制器,並添加一個Post方法,用於處理Post請求:

[Route("api/[controller]")]
[ApiController]
public class RestfulController : ControllerBase
{
    [HttpPost]
    public ActionResult<Model> Post([FromBody] Model model)
    {
        // 處理創建資源的邏輯
        // 返回創建成功的響應,並包含新資源的位置
        return CreatedAtAction(nameof(Get), new { id = model.Id }, model);
    }

    [HttpGet("{id}")]
    public ActionResult<Model> Get(int id)
    {
        // 使用id查詢
        return new Model(1, "bob");
    }
}
public record Model(int Id,string Name);

 

        在上面的示例中,我們使用了[ApiController]和[Route("api/[controller]")]屬性來標註控制器和路由。[ApiController]屬性確保請求的有效性,並自動處理模型綁定和驗證。[Route("api/[controller]")]屬性定義了API的基礎路由,可以替換為你的具體路由。

        在Post方法中,我們使用[FromBody]屬性將請求體中的數據綁定到Model。你可以根據自己的需求來選擇合適的模型。

        處理完創建資源的邏輯後,我們通過CreateAtAction方法返回創建成功的響應。CreateAtAction方法接受三個參數:Action名稱、路由參數、返回的資源對象。在這裡,我們使用"Get"作為Action名稱,表示獲取剛創建的資源的詳細信息。路由參數使用一個匿名對象表示,這個對象包含新資源的唯一標識符(在這個例子中是model.Id)。

在Postman中的效果

 

 

  響應頭包含"Location"指向新資源的URL符合RESTful風格的介面自描述的概念, 介面自描述是指API能夠提供關於其功能和用法的詳細信息。它可以幫助開發者更好地理解如何使用API,減少開發時間和調試錯誤的時間。當一個介面請求完成之後,能夠自描述接下來可能的操作並提供文檔。

        創建成功的響應將包含狀態碼201(Created),並會在響應頭中包含"Location"欄位,指向新資源的URL。

        通過以上步驟,我們成功實現了用CreateAtAction方法返回創建成功的Post請求響應。這樣,我們的API遵循了RESTful風格,並且符合了HTTP標準。

總結

        使用.NET WebApi的CreateAtAction方法可以很方便地返回創建資源的成功響應,並包含新資源的位置。通過遵循RESTful風格的設計原則,我們能夠設計出更加靈活和可擴展的Web應用程式。



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

-Advertisement-
Play Games
更多相關文章
  • 本文將詳細探討如何在Python中連接全種類資料庫以及實現相應的CRUD(創建,讀取,更新,刪除)操作。我們將逐一解析連接MySQL,SQL Server,Oracle,PostgreSQL,MongoDB,SQLite,DB2,Redis,Cassandra,Microsoft Access,El ...
  • 本文將深入探討如何利用Spring Loaded熱更新技術提高開發效率,減少編譯和重啟時間。分析Spring Loaded的熱更新原理,以及實際應用過程中所需的操作和註意事項。 ...
  • Java的特點是百花齊放,不像c#或者go只有一家主導。oracle jdk收費了,沒關係,不是只有它可用。java還有很多免費的主流的jdk發行版本,記錄下來備忘。 OpenJDK - 官方網站 - 源代碼 - 文檔 - 下載地址 OpenJDK是其他所有jdk發行版的基礎,可以用於開發和測試,但 ...
  • 一、問題描述 近日在工作中遇見了一個bug,後端程式頻頻報錯 No bean named 'XXXXX' available 。對比同類程式文件,沒有發現有任何特殊之處。在網上搜索方法基本上就是掃描包配置、註解問題、路徑問題等,皆不能解決我的問題。 排查問題是發現出現問題的類命名不符合駝峰規範,按照 ...
  • ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f4928251cca8446891aafb4d014abf39~tplv-k3u1fbpfcp-zoom-1.image) 博主在瀏覽 medium 社區時,發現了一篇點贊量 1.5k 的文 ...
  • 廢話環節:看過上期文章的小伙伴現在可能還是一頭霧水,怎麼就完成了核心內容,界面呢?哎我說別急讓我先急,博主這不夜以繼日地肝出了界面部分嘛。還是老規矩,不會把所有地方都照顧到,只挑一些有代表性的內容介紹,您各位多擔待🙏。另外博主的JavaFX是跟著B站視頻速成的,指路👉:https://www.b ...
  • ## 目錄 * [1. JUC概述及回顧](#1-juc概述及回顧) * [1.1. JUC是什麼?](#11-juc是什麼) * [1.2. 進程和線程](#12-進程和線程) * [1.3. 並行和併發](#13-並行和併發) * [1.4. wait/sleep的區別](#14-waitsle ...
  • # 🎉Avalonia 11.0.0 正式版發佈! [AvaloniaUI](https://github.com/AvaloniaUI/Avalonia/releases/tag/11.0.0) 發佈11.0.0正式版 終於avalonia發佈了正式版。 ## 更新內容 A11y(輔助功能) 這 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...