主頁 > .NET開發 > 使用ASP.NET Core 3.x 構建 RESTful API - 3.2 路由和HTTP方法

使用ASP.NET Core 3.x 構建 RESTful API - 3.2 路由和HTTP方法

2020-09-11 05:15:19 .NET開發

ASP.NET Core 3.x 的路由

路由機制會把一個請求的URI映射到一個Controller上面的Action,所以當你發送一個HTTP請求的時候,MVC框架會決議這個請求的URI,并嘗試著把它映射到一個Controller上面的Action 

 

兩個路由中間件 

ASP.NET Core 3.x里面,建議使用Endpoint路由來進行設定,但是我們需要先在請求的管道里面添加兩個中間件: 

  • app.UseRouting(),它是用來標記路由決策在請求管道里發生的位置,也就是在這里會選擇端點, 

  • app.UseEndpoints(),它是用來標記選擇好的端點在請求管道的什么地方來執行, 

這樣做的好處就是,我們可以在選擇端點和執行端點的中間位置插入其它的中間件,這樣的話,插入到中間位置的中間件就會知道哪個端點被選取了,而且它也有可能會選擇其它的端點, 

 

一個非常好的例子就是授權中間件: 

app . UseRouting( ) ; app . UseAuthorization( ) ; app . UseEndpoints( endpoints endpoints .MapControllers( ) ;

如果授權成功,那么就繼續執行到之前選定的端點,否則的話就會跳轉到其它端點或者短路回傳, 

 

官方檔案:Startup里面路由配置的官方檔案 

 

映射端點 

還是可以有兩種方式進行設定:基于約定 或者 基于屬性 

基于約定的路由,例如這兩種: 

app . UseEndpoints( endpoints endpoints . MapControllerRoute( "default", name : " {controller=Home} ) ; pattern: endpoints .MapRazorPages( ) ;

這種方式更適合于服務器端的Web應用程式, 

 

而針對Web API,使用基于屬性的路由更加適合: 

app . UseEndpoints( endpoints endpoints .MapControllers( ) ;

可以看到,這里面僅僅映射了Controller,并沒有使用任何約定,所以我們需要采用屬性(Attribute)來進行設定,這里需要用到屬性(attribute)和URI模板, 

  • 屬性(Attribute),例如[Route][HttpGet][HttpPost]等等,可以把它們放在Controller級別,也可以放在Action級別上, 

  • URI模板,將屬性結合URI模板一起使用,就可以把請求映射到ControllerAction上面, 

 

例如: 

ApiController] Route( template: "api/companies " ) ] I reference public class CompaniesController ControllerBase private readonly ICompanyRepository companyRepos i tory ; O references public CompaniesController(ICompanyRepository companyRepository) HttpGet O references public async Task<IActionResult> GetCompanies() await companyRepository .GetCompaniesAsync() ; var companies = return new JsonResult(companies);

 

官方檔案:路由基礎知識 

 

HTTP 方法

不同的動作可以作用于相同的資源URI,例如獲取一個公司(api/company/3)和洗掉一個公司(api/company/3)的URI就是一樣的,但是它們的HTTP方法則不同,一個是GET,一個是DELETE,下面我們就來看看那些動作應該對應哪些 HTTP 方法 

 

POST 

需求:添加一個公司資訊, 

需求圖解: 

添 加 , 加 好 的 公 司 信 , 公 司 信 , 公 司 資 源

 

HTTP請求圖解: 

POST api/companies POST 對 應 的 操 作 就 是 建 立 資 源 POST 的 參 數 放 在 請 求 的 body 里 面 POST ompany 信 息 在 body 里 pi/companies/{ 生 成 的 id} 的 內 容 POST 請 求 應 該 返 回 新 創 建 的 資 源 以 及 可 以 獲 取 該 資 源 的 唯 一 標 識 U 剛 api/Compan ies

 

文字解釋: 

添加公司這個需求的HTTP表示就是 POST api/companies 

當我們向 api/companies這個標示添加一個公司資訊的時候,就會利用提供的公司資訊創建一個公司的資源,這里對應的HTTP方法是POST 

POST請求的引數通常存放在請求的body里面,所以公司的資訊就放在了body里面, 

當公司資源創建好之后,這個action應該回傳新創建的資源以及可以獲取該資源的路徑標識,也就是api/companies/{新資源的id} 

 

GET 

獲取單個資源 

需求:獲取一個公司資訊 

需求圖解: 

獲 取 公 司 信 公 司 資 源

 

HTTP請求圖解: 

GET api/companies/{compayld} GET 對 應 的 動 作 就 是 獲 取 資 源 G ET GET 請 求 會 返 回 請 求 路 徑 所 對 應 的 資 源 pi/companies/{companyld} 的 內 容 不 需 要 參 數 api ℃ ompanies/{companyld} 通 過 這 種 形 式 (URI) 來 表 示 公 司 資 源 中 的 一 個 公 司

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/4451.html

標籤:ASP.NET

上一篇:Razor_01 第一個應用程式

下一篇:制作縮略圖、遠程縮略圖

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more