ASP.NET CORE系列【五】webapi整理以及RESTful風格化

来源:https://www.cnblogs.com/shumin/archive/2018/04/14/8832403.html
-Advertisement-
Play Games

介紹 什麼是RESTful? 這裡不多做贅述,詳情請百度! 哈哈,本來還想巴拉巴拉介紹一些webapi, RESTful的, 還是算了,咱們直接上乾貨!(原因是懶!哈哈) 使用 以前使用過mvc的人對webapi 應該都很熟悉,先看一段熟悉的代碼 大伙發現了什麼沒?跟以往mvc大多數相同,但有些地方 ...


介紹

什麼是RESTful?  這裡不多做贅述,詳情請百度!

哈哈,本來還想巴拉巴拉介紹一些webapi, RESTful的, 還是算了,咱們直接上乾貨!(原因是懶!哈哈)

 

使用

以前使用過mvc的人對webapi 應該都很熟悉,先看一段熟悉的代碼

 

大伙發現了什麼沒?跟以往mvc大多數相同,但有些地方不同 ,我們來一起看看有何區別

1.首先SysUsersController上面有一段代碼

[Produces("application/json")]
    //[Route("api/SysUsers")]
    [Route("api/[controller]/[action]")]
    public class SysUsersController : Controller
    {
    }

註釋的部分先不管,首先我們接收的json格式內容,然後路由是 api/[controller]/[action]

這種情況我們只需要正常的ajax請求就能訪問到了,

 $.ajax({
                    url:'/api/SysUsers/Login',
                    type: 'POST',
                    contentType: "application/json; charset=utf-8",
                    data: {UserName:'shumin',Password:'123456'},
                    success: function (data) {
                        if (data.success) {
                            var href = '@Url.Action("Index")?' + new Date().getTime();
                            window.location.href = href;
                        } else {
                            alert(data.message);
                        }
                    },
                    error: function () {
                        alert('服務端錯誤');
                    }
                });

 

我們運行一下, 發現拿不到數據,

 

   這是為什麼呢,經過多番嘗試,是前臺http請求不對,因為我們約定的json傳輸,所以數據需要序列化

   

 $.ajax({
                    url:'/api/SysUsers/Login',
                    type: 'POST',
                    contentType: "application/json; charset=utf-8",
                    data: JSON.stringify({UserName:'shumin',Password:'123456'}),
                    success: function (data) {
                        if (data.success) {
                            var href = '@Url.Action("Index")?' + new Date().getTime();
                            window.location.href = href;
                        } else {
                            alert(data.message);
                        }
                    },
                    error: function () {
                        alert('服務端錯誤');
                    }
                });

  還有一點需要註意的事,ajax預設的

contentType是application/x-www-form-urlencoded

我們需要改成application/json; charset=utf-8

這樣就可以拿到數據了

 

 

RESTful 

  推薦一個關於RESTful的介紹文章 http://www.ruanyifeng.com/blog/2014/05/restful_api

  用上面那種方法,會導致URL又臭又長,舉個例子

  網站:/get_user?id=3
  RESTFul: GET /user/3 (GET是HTTP類型)

  以前的時候我們寫http請求,只會用get  post兩種,

  而註冊對應的資源是user,api如下: 

  GET /user/:id # 獲取id用戶的信息 
  POST /user # 創建新的用戶(註冊) 
  PUT /user/:id # 更新id用戶的信息 
  DELETE /user/:id # 刪除id用戶(註銷)

  我們一起來看看RESTFul API有哪些特點:

  1. 基於“資源”,數據也好、服務也好,在RESTFul設計里一切都是資源。
  2. 無狀態。一次調用一般就會返回結果,不存在類似於“打開連接-訪問數據-關閉連接”這種依賴於上一次調用的情況。
  3. URL中通常不出現動詞,只有名詞
  4. URL語義清晰、明確
  5. 使用HTTP的GET、POST、DELETE、PUT來表示對於資源的增刪改查
  6. 使用JSON不使用XML

我們接著來看一看RESTFul API的一些最佳實踐原則:

  1. 使用HTTP動詞表示增刪改查資源, GET:查詢,POST:新增,PUT:更新,DELETE:刪除
  2. 返回結果必須使用JSON
  3. HTTP狀態碼,在REST中都有特定的意義:200,201,202,204,400,401,403,500。比如401表示用戶身份認證失敗,403表示你驗證身份通過了,但這個資源你不能操作。

        這裡直接貼出RESTful的api僅供參考

        

namespace NetCoreAdmin.Controllers
{
    [Produces("application/json")]
    [Route("api/SysUsers")] 
    public class SysUsersController : Controller
    {
        private readonly EFCoreContext _context;

        public SysUsersController(EFCoreContext context)
        {
            _context = context;
        }

        // GET: api/SysUsers
        [HttpGet]
        public IEnumerable<SysUser> GetSysUsers()
        {
            return _context.SysUsers;
        }

        // GET: api/SysUsers/5
        [HttpGet("{id}")]
        public async Task<IActionResult> GetSysUser([FromRoute] int id)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            var sysUser = await _context.SysUsers.SingleOrDefaultAsync(m => m.Id == id);

            if (sysUser == null)
            {
                return NotFound();
            }

            return Ok(sysUser);
        }

        // PUT: api/SysUsers/5
        [HttpPut("{id}")]
        public async Task<IActionResult> PutSysUser([FromRoute] int id, [FromBody] SysUser sysUser)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            if (id != sysUser.Id)
            {
                return BadRequest();
            }

            _context.Entry(sysUser).State = EntityState.Modified;

            try
            {
                await _context.SaveChangesAsync();
            }
            catch (DbUpdateConcurrencyException)
            {
                if (!SysUserExists(id))
                {
                    return NotFound();
                }
                else
                {
                    throw;
                }
            }

            return NoContent();
        }

        // POST: api/SysUsers
        [HttpPost]
        public async Task<IActionResult> PostSysUser([FromBody] SysUser sysUser)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            _context.SysUsers.Add(sysUser);
            await _context.SaveChangesAsync();

            return CreatedAtAction("GetSysUser", new { id = sysUser.Id }, sysUser);
        }

        // DELETE: api/SysUsers/5
        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteSysUser([FromRoute] int id)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            var sysUser = await _context.SysUsers.SingleOrDefaultAsync(m => m.Id == id);
            if (sysUser == null)
            {
                return NotFound();
            }

            _context.SysUsers.Remove(sysUser);
            await _context.SaveChangesAsync();

            return Ok(sysUser);
        }

        private bool SysUserExists(int id)
        {
            return _context.SysUsers.Any(e => e.Id == id);
        }
    }
}

 

        

        


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

-Advertisement-
Play Games
更多相關文章
  • 面向對象--介面 ...
  • 一。添加控制項lrisSkin.dll 然後把繼承的窗體更換成別人做好的窗體類 能達到換膚的效果 二。 全部源代碼就一行: skinEngine1.SkinFile = "WaveColor1.ssk"; 其中ssk文件為皮膚文件。 如果上面的不行,就設置skinEngine1控制項的SkinFile屬 ...
  • 一直在用DateTime, 卻不常用TimeSpan , 今天突然用到了, 發現不知道咋做格式化...百度一下,找到了答案, 在這記錄一下, 免得以後找花費時間 以下內容摘抄自 Microsoft Docs 原文地址: https://docs.microsoft.com/en-us/previou ...
  • 這是一個C#寫的漂亮的工控軟體控制項源代碼, 我們在編寫工業控制軟體的時候,經常會為界面不美觀而發愁,這個源代碼上的控制項都比較漂亮,很符合工業風格,需要的朋友可以下載 ; 開始下載 ...
  • 學習開發這麼久了,自然要將開發中經典的練習軟體實踐下。 經典的進銷存系統功能有很多,我這裡想根據角色來介紹,感覺這樣思路比較清晰。 首先是角色分類,一般的分為採購人員、普通員工、系統管理員、審核人員。 先介紹所有角色通用的功能 採購人員 普通員工 審核人員 管理員 ...
  • 那是由於具有空文件名的庫導致的,只需要檢查一下配置信息把出現空文件名的地方進行改正就可以了。 作者:耑新新,發佈於 博客園 轉載請註明出處,歡迎郵件交流:[email protected] ...
  • 一 寫在開頭1.1 寫在開頭微軟是一家偉大的公司。評價一門技術的好壞得看具體的需求,沒有哪門技術是面面俱到地好,應該拋棄對微軟和微軟的技術的偏見。 1.2 本文內容本文主要內容為WPF中的常用佈局,大部分內容轉載至https://blog.csdn.net/woshisunjiale/article ...
  • 預設值表達式生成類型的預設值。 預設值表達式在泛型類和泛型方法中非常有用。 使用泛型類和泛型方法時出現的一個問題是,如何在無法提前知道以下內容的情況下將預設值賦值給參數化類型 T: T 是引用類型還是值類型。 如果 T 是值類型,它是數值還是用戶定義的結構。 已知參數化類型 T 的變數 t,僅當 T ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...