如何使用 RestSharp 調(diào)用 WebAPI 接口

REST 是由 Representational State Transfer 這三個(gè)單詞前綴合成吊圾,這種架構(gòu)風(fēng)格在前幾年特別流行达椰,Restful API 的行為規(guī)范可以參考: https://docs.microsoft.com/en-us/azure/architecture/best-practices/api-design ,通常 RESTful API 返回的格式為常見的 PlianText项乒, JSON 啰劲, XML 格式。

RestSharp 是一個(gè)開源的 Http 客戶端類庫板丽,非常方便和 RESTful 格式的 Service 進(jìn)行交互,????的是呈枉,這個(gè)類庫封裝了 request 請求過程中復(fù)雜的細(xì)節(jié),而且 RestSharp 支持同步和異步兩種請求模式埃碱。

這篇文章將會討論如何使用 RestSharp 去請求 Asp.NET Core 服務(wù)猖辫。

實(shí)現(xiàn) DefaultController

打開 DefaultController.cs 文件并用下面的代碼進(jìn)行替換。

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 類砚殿,可以發(fā)現(xiàn) Action 方法的名字對應(yīng)著 Http 動詞的 GET,POST,PUT 和 DELETE啃憎,為了簡單起見,我使用了 Dictionary 來存取數(shù)據(jù)似炎,你可以用 瀏覽器 或者 Postman 或者 Fiddler 進(jìn)行測試辛萍,請注意,這里為了方便羡藐,我在 Post 方法中使用了硬編碼贩毕,實(shí)際場景中你可以用自己的方式生成唯一ID。

接下來的章節(jié)我們將會學(xué)習(xí)如何使用 RestSharp 去調(diào)用剛才構(gòu)建的 API 接口仆嗦。

安裝 RestSharp

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

Install-Package RestSharp

image.gif

使用 RestSharp 調(diào)用 ASP.NET Core API

一旦 RestSharp 成功引用到項(xiàng)目之后,就可以使用它了谆甜,首先, 你需要創(chuàng)建 RestClient 實(shí)例垃僚,下面的代碼展示了如何對 RestClient 進(jìn)行實(shí)例化和初始化操作,要注意的是構(gòu)造函數(shù)中的 url 配置的是 基址规辱,言外之意這不是完整的url谆棺。

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

image.gif

接下來,你可以傳遞 資源名請求方式 兩個(gè)參數(shù)來實(shí)例化 RestRequest 對象罕袋,下面的代碼展示了如何實(shí)現(xiàn)改淑。

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

image.gif

最后,你可以執(zhí)行 request 請求炫贤,再將返回的結(jié)果序列化溅固, 最后用一個(gè)合適的對象接收,就像下面代碼一樣兰珍。

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 發(fā)送 POST 請求,可以使用如下代碼掠河。

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

image.gif

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末藕赞,一起剝皮案震驚了整個(gè)濱河市成肘,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌斧蜕,老刑警劉巖双霍,帶你破解...
    沈念sama閱讀 211,042評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異批销,居然都是意外死亡洒闸,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評論 2 384
  • 文/潘曉璐 我一進(jìn)店門均芽,熙熙樓的掌柜王于貴愁眉苦臉地迎上來丘逸,“玉大人,你說我怎么就攤上這事掀宋∩罡伲” “怎么了羞反?”我有些...
    開封第一講書人閱讀 156,674評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長囤萤。 經(jīng)常有香客問我,道長是趴,這世上最難降的妖魔是什么涛舍? 我笑而不...
    開封第一講書人閱讀 56,340評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮唆途,結(jié)果婚禮上富雅,老公的妹妹穿的比我還像新娘。我一直安慰自己肛搬,他們只是感情好没佑,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,404評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著温赔,像睡著了一般蛤奢。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上陶贼,一...
    開封第一講書人閱讀 49,749評論 1 289
  • 那天啤贩,我揣著相機(jī)與錄音,去河邊找鬼拜秧。 笑死痹屹,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的枉氮。 我是一名探鬼主播志衍,決...
    沈念sama閱讀 38,902評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼聊替!你這毒婦竟也來了楼肪?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,662評論 0 266
  • 序言:老撾萬榮一對情侶失蹤佃牛,失蹤者是張志新(化名)和其女友劉穎淹辞,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體俘侠,經(jīng)...
    沈念sama閱讀 44,110評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡象缀,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了爷速。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片央星。...
    茶點(diǎn)故事閱讀 38,577評論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖惫东,靈堂內(nèi)的尸體忽然破棺而出莉给,到底是詐尸還是另有隱情毙石,我是刑警寧澤,帶...
    沈念sama閱讀 34,258評論 4 328
  • 正文 年R本政府宣布颓遏,位于F島的核電站徐矩,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏叁幢。R本人自食惡果不足惜滤灯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,848評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望曼玩。 院中可真熱鬧鳞骤,春花似錦、人聲如沸黍判。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽顷帖。三九已至美旧,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間贬墩,已是汗流浹背陈症。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1 264
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留震糖,地道東北人录肯。 一個(gè)月前我還...
    沈念sama閱讀 46,271評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像吊说,于是被迫代替她去往敵國和親论咏。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,452評論 2 348

推薦閱讀更多精彩內(nèi)容