如何使用 RestSharp 調用 WebAPI 接口

REST 是由 Representational State Transfer 這三個單詞前綴合成,這種架構風格在前幾年特別流行,Restful API 的行為規范可以參考: https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design ,通常 RESTful API 返回的格式為常見的 PlianText, JSON , XML 格式。

RestSharp 是一個開源的 Http 客戶端類庫,非常方便和 RESTful 格式的 Service 進行交互,????的是,這個類庫封裝了 request 請求過程中復雜的細節,而且 RestSharp 支持同步和異步兩種請求模式。

這篇文章將會討論如何使用 RestSharp 去請求 Asp.NET Core 服務。

實現 DefaultController

打開 DefaultController.cs 文件并用下面的代碼進行替換。

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;

namespace RESTAPIDemo.Controllers
{
   [Route("api/[controller]")]
   [ApiController]
   public class DefaultController : ControllerBase
   {
       private readonly Dictionary<int, string> authors = new Dictionary<int, string>();
       public DefaultController()
       {
           authors.Add(1, "Joydip Kanjilal");
           authors.Add(2, "Steve Smith");
           authors.Add(3, "Michele Smith");
       }

       [HttpGet]
       public List<string> Get()
       {
           List<string> lstAuthors = new List<string>();
           foreach (KeyValuePair<int,string> keyValuePair in authors)
               lstAuthors.Add(keyValuePair.Value);
           return lstAuthors;
       }

       [HttpGet("{id}", Name = "Get")]
       public string Get(int id)
       {
           return authors[id];
       }

       [HttpPost]
       public void Post([FromBody] string value)
       {
           authors.Add(4, value);
       }

       [HttpPut("{id}")]
       public void Put(int id, [FromBody] string value)
       {
           authors[id] = value;
       }

       [HttpDelete("{id}")]
       public void Delete(int id)
       {
           authors.Remove(id);
       }
   }
}

image.gif

參考上面的 DefaultController 類,可以發現 Action 方法的名字對應著 Http 動詞的 GET,POST,PUT 和 DELETE,為了簡單起見,我使用了 Dictionary 來存取數據,你可以用 瀏覽器 或者 Postman 或者 Fiddler 進行測試,請注意,這里為了方便,我在 Post 方法中使用了硬編碼,實際場景中你可以用自己的方式生成唯一ID。

接下來的章節我們將會學習如何使用 RestSharp 去調用剛才構建的 API 接口。

安裝 RestSharp

要想使用 RestSharp,你可以使用 Visual Studio 2019 中的 NuGet package manager 可視化界面進行安裝,或者通過 NuGet package manager console 命令行輸入如下命令:

Install-Package RestSharp

image.gif

使用 RestSharp 調用 ASP.NET Core API

一旦 RestSharp 成功引用到項目之后,就可以使用它了,首先, 你需要創建 RestClient 實例,下面的代碼展示了如何對 RestClient 進行實例化和初始化操作,要注意的是構造函數中的 url 配置的是 基址,言外之意這不是完整的url。

RestClient client = new RestClient("http://localhost:58179/api/");

image.gif

接下來,你可以傳遞 資源名請求方式 兩個參數來實例化 RestRequest 對象,下面的代碼展示了如何實現。

RestRequest request = new RestRequest("Default", Method.GET);

image.gif

最后,你可以執行 request 請求,再將返回的結果序列化, 最后用一個合適的對象接收,就像下面代碼一樣。

IRestResponse<List<string>> response = client.Execute<List<string>>(request);

image.gif

下面是完整的可供參考的代碼清單。

using RestSharp;
using System;
using System.Collections.Generic;
namespace RESTSharpClientDemo
{
    class Program
    {
        private static RestClient client = new RestClient("http://localhost:58179/api/");

        static void Main(string[] args)
        {
            RestRequest request = new RestRequest("Default",Method.GET);
            IRestResponse<List<string>> response = client.Execute<List<string>>(request);
            Console.ReadKey();
        }
    }
}

image.gif

如果想使用 RestSharp 發送 POST 請求,可以使用如下代碼。

RestRequest request = new RestRequest("Default", Method.POST);
request.AddJsonBody("Robert Michael");
var response = client.Execute(request);

image.gif

RestSharp 可以跨多個 .NET 平臺使用,比如說:Momo,Xarmain,Blazer 等等,這也是它為什么非常流行的原因,而且 RestSharp 支持通過泛型方式獲取結果,這個特性特別 ????,想了解更多 RestSharp 知識,可參考 Github:https://github.com/restsharp/RestSharp

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,247評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,520評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,362評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,805評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,541評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,896評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,887評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,062評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,608評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,356評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,555評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,077評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,769評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,175評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,489評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,289評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,516評論 2 379

推薦閱讀更多精彩內容