C# の REST API

このチュートリアルでは、C# で REST API 呼び出しを行う方法について説明します。

C# の RestSharp クライアントを使用した REST API 呼び出し

RestSharp は、おそらく C# で最も人気のある REST API クライアントです。このクライアントを使用して、API から受信したデータをプレーンオールドクラスオブジェクト（POCO）にキャストできます。この目的のために、最初に API 呼び出しによって返されるフィールドを含むデータモデルクラスを作成する必要があります。次のコード例は、C# のサンプルデータモデルクラスを示しています。RestSharp クライアントはサードパーティのパッケージであり、プリインストールされていません。このアプローチを機能させるには、RestSharp パッケージをインストールする必要があります。

class dataModel {
  public int UserID { get; set; }
  public string UserName { get; set; }
}

上記の dataModel クラスは、API コールレスポンスで返されたユーザーの ID と名前を保存できます。次のコード例は、C# で RestSharp クライアントを使用して API 呼び出しを実行する方法を示しています。

Uri Url = new Uri("https://exampleUrl.com");
IRestClient restClient = new RestClient(Url);
IRestRequest restRequest = new RestRequest(
    "get", Method.GET) { Credentials = new NetworkCredential("Admin", "strongpassword") };
IRestResponse<dataModel> restResponse = restClient.Execute<dataModel>(restRequest);

if (restResponse.IsSuccessful) {
  dataModel model = restResponse.Data;
} else {
  Console.WriteLine(restResponse.ErrorMessage);
}

上記のコードでは、C# の RestSharp クライアントを使用して REST API に GET リクエストを行いました。dataModel クラスと呼ばれる API によって返されるデータを保持するクラスを作成しました。次に、リクエストを実行し、レスポンスで返されたデータを dataModel クラスのインスタンスに保存しました。