使用ASP.NET Core 3.x 构建 RESTful API - 3.2 开始建立Controller和Action
Demo
下面我們就來實踐一下。打開之前的項目,并建立CompaniesController:?
這里有6個地方比較關鍵,我們挨個看一下:?
RESTful API?或者其它Web API的Controller都應該繼承于?ControllerBase?這個類(點此查看詳細的官方文檔),而不是Controller這個類。?
?
ControllerBase?類提供了很多用于處理?HTTP?請求的屬性和方法。?例如,ControllerBase.CreatedAtAction?返回?201?狀態代碼。關于ControllerBase的屬性和方法的詳細列表,請查看官方參考文檔。?
[ApiController]。這個屬性是應用于Controller的,它其實并不是強制的,但是它提供了一些幫助,使得Web API的開發體驗更好。詳細教程請點擊?[ApiController]的官方文檔。在Controller上面添加了[ApiController]屬性之后,就會啟用以下行為:?
要求使用屬性路由(Attribute Routing)。也就是不能通過Startup的Configure方法統一配置路由模板。這部分的詳細介紹請點擊:官方文檔。?
自動HTTP 400響應。也就是Action方法傳入的model含有驗證錯誤的時候,自動觸發HTTP 400響應。這部分的詳細介紹請點擊:官方文檔。?
推斷參數的綁定源。它將會推斷出Action方法的參數到底來自哪個綁定源,例如[FromBody]、[FromForm]等等。這部分的詳細介紹請點擊:官方文檔。?
Multipart/form-data?請求推斷。使用?[FromForm]?屬性批注操作參數時,[ApiController]?屬性將應用推斷規則,它會推斷?multipart/form-data?為請求的內容類型。這部分的詳細介紹請點擊:官方文檔。?
錯誤狀態代碼的問題詳細信息。MVC?會將錯誤結果(狀態代碼為?400?或更高的結果)轉換為狀態代碼為?ProblemDetails?的結果。?ProblemDetails?類型基于?RFC 7807?規范,用于提供?HTTP?響應中計算機可讀的錯誤詳細信息。這部分的詳細介紹請點擊:官方文檔。?
我們需要通過構造函數注入ICompanyRepository,并把它存放在一個只讀的字段里面。?
如果注入的ICompanyRepository的實例為null,那么就拋出一個ArgumentNullException。?
想要返回數據結果,我們需要在Controller里面添加一個Action方法。我暫時把它的返回類型寫為IActionResult(詳細介紹請點擊官方文檔)。IActionResult里面定義了一些合約,它們可以代表Action方法返回的結果。?
我暫時只想把結果序列化為JSON格式并返回,這里我new了一個JsonResult(參考文檔),它可以做這項工作。?
?
目前我只做了這幾項最基本的工作:創建Controller,注入Repository,創建Action方法并返回結果。下面運行一下看看報了什么錯:?
這是因為GetCompanies這個Action方法并沒有使用屬性路由(Attribute Routing)。關于路由這部分,下一篇文章再介紹。?
點擊原文查看博客園的博文,主要是里面有文檔的鏈接.
總結
以上是生活随笔為你收集整理的使用ASP.NET Core 3.x 构建 RESTful API - 3.2 开始建立Controller和Action的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: “兼职”运维的常用命令
- 下一篇: Deepin 下 使用 Rider 开发