如何使用 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);
       }
   }
}

參考上面的 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

使用 RestSharp 調用 ASP.NET Core API

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

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

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

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

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

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

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

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();
        }
    }
}

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

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

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