Message icon
フッターコンテンツにスキップ
  1. IronPDF
  2. IronPDF ブログ
  3. .NETヘルプ
  4. RestSharp C#
.NETヘルプ

RestSharp C# (開発者向けの仕組み)

Jacob Mellor、Ironチームの最高技術責任者（CTO）
Jacob Mellor
更新日:

RestSharpは、C#でHTTPリクエストを行うための人気のオープンソース.NETライブラリです。 それは、RESTful APIを操作するプロセスを簡略化し、ウェブサービスと通信するためのシンプルで柔軟な方法を提供します。 この記事では、RestSharpとIronPDFの重要な機能を探り、データを抽出してPDFを生成する方法を紹介します。

なぜRestSharpなのか？

現代のマルチティアアプリケーションでは、異なるサービスが頻繁に通信する必要があり、RestSharpは複雑さをすべてカプセル化することでシンプルで効率的な方法を提供します。 これは、ソフトウェア開発プロセスを大いに簡素化します。

RestSharpのインストール

RestSharpはNuGetパッケージとして提供されており、C#プロジェクトにインストールできます。 これは、NuGetパッケージマネージャコンソールまたはVisual StudioのNuGetパッケージマネージャUIを使用して実行できます。

Install-Package RestSharp

簡単なGETリクエストの作成

RestSharpを使用してRESTful APIへのGETリクエストを行う簡単な例から始めましょう。公開されているASP.NETコアAPIからユーザーデータを取得したいと仮定します。

using RestSharp;
namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            // Base URL for the REST API
            var baseUrl = "https://jsonplaceholder.typicode.com/users";

            // Create a RestClientOptions with default credentials
            var options = new RestClientOptions(baseUrl) { UseDefaultCredentials = true };
            var client = new RestClient(options);

            // Create a RestRequest for the GET method
            var request = new RestRequest();

            // Execute the request and get the response
            var response = client.Get(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Output the response body content
                Console.WriteLine(response.Content);
            }
            else
            {
                // Handle the error
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }

        // Additional method to log data
        public void LogData(string msg)
        {
            Console.WriteLine(msg);
        }
    }
}
using RestSharp;
namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            // Base URL for the REST API
            var baseUrl = "https://jsonplaceholder.typicode.com/users";

            // Create a RestClientOptions with default credentials
            var options = new RestClientOptions(baseUrl) { UseDefaultCredentials = true };
            var client = new RestClient(options);

            // Create a RestRequest for the GET method
            var request = new RestRequest();

            // Execute the request and get the response
            var response = client.Get(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Output the response body content
                Console.WriteLine(response.Content);
            }
            else
            {
                // Handle the error
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }

        // Additional method to log data
        public void LogData(string msg)
        {
            Console.WriteLine(msg);
        }
    }
}
$vbLabelText   $csharpLabel

RestSharpは、非同期APIメソッドを使用して非同期リクエストとレスポンスをサポートしています。

レスポンスデータの処理

RestSharpは、レスポンスの内容をC#オブジェクトにデシリアライズするための便利な方法を提供します。 例を拡張して、JSONレスポンスデータをユーザーオブジェクトのリストにデシリアライズしてみましょう。

// Deserialize JSON response into a list of User objects
var users = JsonSerializer.Deserialize<List<User>>(response.Content);

// Output user information
foreach (var user in users)
{
    Console.WriteLine($"User ID: {user.Id}, Name: {user.Name}, Email: {user.Email}");
}
// Deserialize JSON response into a list of User objects
var users = JsonSerializer.Deserialize<List<User>>(response.Content);

// Output user information
foreach (var user in users)
{
    Console.WriteLine($"User ID: {user.Id}, Name: {user.Name}, Email: {user.Email}");
}
$vbLabelText   $csharpLabel

この例では、JSON フィールドに対応するプロパティを持つ User クラスを定義しています。 System.Text.Json 名前空間から JsonSerializer.Deserialize を使用しました。

public class User
{
    [JsonPropertyName("company")]
    public Company Company { get; set; }

    [JsonPropertyName("id")]
    public int Id { get; set; }

    [JsonPropertyName("phone")]
    public string Phone { get; set; }

    [JsonPropertyName("website")]
    public string Website { get; set; }

    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("username")]
    public string Username { get; set; }

    [JsonPropertyName("email")]
    public string Email { get; set; }

    [JsonPropertyName("address")]
    public Address Address { get; set; }
}
public class User
{
    [JsonPropertyName("company")]
    public Company Company { get; set; }

    [JsonPropertyName("id")]
    public int Id { get; set; }

    [JsonPropertyName("phone")]
    public string Phone { get; set; }

    [JsonPropertyName("website")]
    public string Website { get; set; }

    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("username")]
    public string Username { get; set; }

    [JsonPropertyName("email")]
    public string Email { get; set; }

    [JsonPropertyName("address")]
    public Address Address { get; set; }
}
$vbLabelText   $csharpLabel

出力

すべてのユーザーIDと名前が出力に表示されます。

RestSharp C# (開発者向けの仕組み): 図 1 - すべてのユーザー ID と名前を表示するコンソール出力。

全コードは、このリンクにGitで利用可能です。

コンテンツタイプ

RestSharpはXMLまたはJSONボディリクエストを送信することをサポートしています。 RestRequest インスタンスの AddJsonBody または AddXmlBody メソッドを使用して、JSON または XML 本文を追加できます。 RestSharpは、コンテンツタイプを自動的に設定します。 JSONまたはXMLのレスポンスも自動的に処理します。

// Serialize the user object to JSON
var jsonBodyString = JsonSerializer.Serialize(newUser);

// Create a RestRequest for the POST method with the JSON request data
var requestData = new RestRequest().AddJsonBody(jsonBodyString);
var response = client.ExecutePost(requestData);
// Serialize the user object to JSON
var jsonBodyString = JsonSerializer.Serialize(newUser);

// Create a RestRequest for the POST method with the JSON request data
var requestData = new RestRequest().AddJsonBody(jsonBodyString);
var response = client.ExecutePost(requestData);
$vbLabelText   $csharpLabel

データをPOSTリクエストで送信する

RestSharpは、リクエストボディでデータを送信することもサポートしており、リソースを作成または更新する場合によく使用されます。 例を修正して、POSTリクエストAPIを示します:

using RestSharp;
using System.Text.Json;

namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            var client = new RestClient("https://jsonplaceholder.typicode.com/users");

            // New user object
            var newUser = new User
            {
                Name = "John Doe",
                Email = "john.doe@example.com"
            };

            // Serialize the user object to JSON
            var jsonBody = JsonSerializer.Serialize(newUser);

            // Create a RestRequest for the POST method with the JSON request body
            var request = new RestRequest().AddJsonBody(jsonBody);

            // Execute the POST request
            var response = client.ExecutePost(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Output the response content
                Console.WriteLine(response.Content);
            }
            else
            {
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }
    }
}
using RestSharp;
using System.Text.Json;

namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            var client = new RestClient("https://jsonplaceholder.typicode.com/users");

            // New user object
            var newUser = new User
            {
                Name = "John Doe",
                Email = "john.doe@example.com"
            };

            // Serialize the user object to JSON
            var jsonBody = JsonSerializer.Serialize(newUser);

            // Create a RestRequest for the POST method with the JSON request body
            var request = new RestRequest().AddJsonBody(jsonBody);

            // Execute the POST request
            var response = client.ExecutePost(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Output the response content
                Console.WriteLine(response.Content);
            }
            else
            {
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }
    }
}
$vbLabelText   $csharpLabel

この例では、新しい User オブジェクトを作成し、それを JSON にシリアル化し、 AddJsonBody メソッドを使用してリクエスト本文に含めます。 サーバーはJSONデータを受信し、要求を適切に処理します。

出力

RestSharp C# (開発者向けの仕組み): 図 2 - コンソール出力

認証

RestSharpは、認証を使用してリクエストを送信することもサポートしています。 RestClientOptions には認証パラメータを含めることができます。

var options = new RestClientOptions("https://auth.net")
{
    Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret)
};
var options = new RestClientOptions("https://auth.net")
{
    Authenticator = new HttpBasicAuthenticator(_clientId, _clientSecret)
};
$vbLabelText   $csharpLabel

ここでは、クライアントIDシークレット認証を使用しており、すべてのリクエストで送信されています。

エラーハンドリング

RestSharpは、タイムアウト、認証、または認可エラーなどのURL要求中に発生するエラーを処理できます。 RestSharpは、リクエストが自動的に失敗しても例外をスローしません。 手動で設定する必要があります。

以下のエラーハンドリング構成が可能です:

  • FailOnDeserializationError:このプロパティを true に設定すると、RestSharp は失敗した逆シリアル化をエラーと見なし、それに応じて ResponseStatus を Error に設定します。
  • ThrowOnDeserializationError:このプロパティを true に設定すると、逆シリアル化が失敗したときに RestSharp がスローするように指示します。
  • ThrowOnAnyError:リクエストの実行時または逆シリアル化中にエラーが発生した場合、例外をスローします。
var restClientOptions = new RestClientOptions(url)
{
    ThrowOnAnyError = true
};
var client = new RestClient(restClientOptions);
var restClientOptions = new RestClientOptions(url)
{
    ThrowOnAnyError = true
};
var client = new RestClient(restClientOptions);
$vbLabelText   $csharpLabel

IronPDFの紹介

IronPDFは、Iron SoftwareのC# PDFライブラリで、PDFドキュメントの読み取りと生成をサポートします。 スタイル情報を含むフォーマットされたドキュメントを簡単にPDFに変換できる。 IronPDFは、HTMLコンテンツから簡単にPDFを生成できます; URLからHTMLをダウンロードしてPDFを生成できます。

IronPDFの重要な機能はHTMLからPDFへの変換で、レイアウトとスタイルをすべて保持します。 ウェブコンテンツをPDFに変換するので、レポート、請求書、ドキュメントに最適です。 HTMLファイル、URL、およびHTML文字列を簡単にPDFに変換できます。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        // Create a PDF renderer using Chrome
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        // Create a PDF renderer using Chrome
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
$vbLabelText   $csharpLabel

IronPDFライブラリをインストールする

NuGetパッケージマネージャを使用して、Selenium RestSharpプロジェクトにIronPDFを統合するには、次の手順に従います:

  1. Visual Studioを開き、ソリューションエクスプローラーでプロジェクトを右クリックします。
  2. コンテキストメニューから"NuGetパッケージの管理..."を選択します。
  3. [参照]タブに移動して、IronPDFを検索します。
  4. 検索結果からIronPDFライブラリを選択し、インストールボタンをクリックします。
  5. ライセンス契約のプロンプトを承諾します。

パッケージマネージャコンソールを介してプロジェクトにIronPDFを含めたい場合は、パッケージマネージャコンソールで次のコマンドを実行します:

Install-Package IronPdf

プロジェクトに IronPDF を取得してインストールします。

NuGet ウェブサイトを使ってインストール

機能、互換性、追加のダウンロードオプションを含む IronPDF の詳細な概要については、NuGet ウェブサイトの IronPDF ページを訪れてください。https://www.nuget.org/packages/IronPdf。

DLLを介してインストール

また、DLLファイルを直接使用してプロジェクトにIronPDFを取り込むこともできます。IronPDF ダウンロードからDLLを含むZIPファイルをダウンロードします。 それを解凍してプロジェクトにDLLを含めます。

ここで、すべてのユーザーを取得し、HTML文字列とIronPDFジェネレーターを使用してPDFレポートを生成します。

using System.Text.Json;
using System.Text.Json.Serialization;
using RestSharp;
using IronPdf;

namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            // Create a RestClient
            var baseUrl = "https://jsonplaceholder.typicode.com/users";
            RestClientOptions options = new RestClientOptions(baseUrl) { UseDefaultCredentials = true };
            var client = new RestClient(options);

            // Create a RestRequest for the GET method
            var request = new RestRequest();

            // Execute the request and get the response
            var response = client.Get(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Deserialize JSON response into a list of User objects
                var users = JsonSerializer.Deserialize<List<User>>(response.Content);

                // Generate PDF
                var html = GetHtml(users);
                var renderer = new ChromePdfRenderer();
                var pdf = renderer.RenderHtmlAsPdf(html);
                pdf.SaveAs("UsersReport.pdf");
            }
            else
            {
                // Handle the error
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }

        // Method to generate HTML from user data
        private static string GetHtml(List<User>? users)
        {
            string header = @"
<html>
<head><title>Users List</title></head>
<body>
";
            var footer = @"
</body>
</html>";
            var htmlContent = header;
            foreach (var user in users)
            {
                htmlContent += $@"
    <h1>{user.Name}</h1>
    <p>Username: {user.Username}</p>
    <p>Email: {user.Email}</p>
    <p>Company: {user.Company}</p>
    <p>Phone: {user.Phone}</p>
    <p>Website: {user.Website}</p>
    <p>Suite: {user.Address.Suite}</p>
    <p>Street: {user.Address.Street}</p>
    <p>City: {user.Address.City}</p>
    <p>Zipcode: {user.Address.Zipcode}</p>
";
            }
            htmlContent += footer;
            return htmlContent;
        }
    }
}
using System.Text.Json;
using System.Text.Json.Serialization;
using RestSharp;
using IronPdf;

namespace rest_sharp_demo
{
    class Program
    {
        static void Main()
        {
            // Create a RestClient
            var baseUrl = "https://jsonplaceholder.typicode.com/users";
            RestClientOptions options = new RestClientOptions(baseUrl) { UseDefaultCredentials = true };
            var client = new RestClient(options);

            // Create a RestRequest for the GET method
            var request = new RestRequest();

            // Execute the request and get the response
            var response = client.Get(request);

            // Check if the request was successful
            if (response.IsSuccessful)
            {
                // Deserialize JSON response into a list of User objects
                var users = JsonSerializer.Deserialize<List<User>>(response.Content);

                // Generate PDF
                var html = GetHtml(users);
                var renderer = new ChromePdfRenderer();
                var pdf = renderer.RenderHtmlAsPdf(html);
                pdf.SaveAs("UsersReport.pdf");
            }
            else
            {
                // Handle the error
                Console.WriteLine($"Error: {response.ErrorMessage}");
            }
        }

        // Method to generate HTML from user data
        private static string GetHtml(List<User>? users)
        {
            string header = @"
<html>
<head><title>Users List</title></head>
<body>
";
            var footer = @"
</body>
</html>";
            var htmlContent = header;
            foreach (var user in users)
            {
                htmlContent += $@"
    <h1>{user.Name}</h1>
    <p>Username: {user.Username}</p>
    <p>Email: {user.Email}</p>
    <p>Company: {user.Company}</p>
    <p>Phone: {user.Phone}</p>
    <p>Website: {user.Website}</p>
    <p>Suite: {user.Address.Suite}</p>
    <p>Street: {user.Address.Street}</p>
    <p>City: {user.Address.City}</p>
    <p>Zipcode: {user.Address.Zipcode}</p>
";
            }
            htmlContent += footer;
            return htmlContent;
        }
    }
}
$vbLabelText   $csharpLabel

全コードはGitでこのリンクで確認できます。

ここでは、最初にユーザーリストから必要なレポートのすべてのフォーマットを備えたHTML文字列を生成します。 次に、IronPDFを使用してPDFドキュメントを生成します。 HTML 文字列を PDF ドキュメントに変換するには、RenderHtmlAsPdf メソッドを使用します。 生成されたドキュメントは以下の通りです:

RestSharp C# (開発者向けの仕組み): 図 4 - 出力 PDF

ドキュメントには試用ライセンス用の小さな透かしがあり、有効なライセンスを使用して削除できます。

ライセンス (無料トライアル利用可能)

上記のコードを機能させるには、ライセンスキーが必要です。 このキーは次のように appsettings.json に配置する必要があります。

{
    "IronPdf.LicenseKey": "your license key"
}

試用ライセンスは、登録すると開発者に提供され、試用ライセンスにはクレジットカードは必要ありません。 自分のメールIDを提供して、無料試用に登録できます。

結論

RestSharpライブラリは、C#でRESTful APIを操作するプロセスを簡素化し、HTTP要求を行いレスポンスを処理するためのクリーンで効率的な方法を提供します。 GETリクエストでデータを取得する場合でも、POSTリクエストでデータを送信する場合でも、RestSharpの直感的なAPIと便利な機能は、ウェブサービスと連携するアプリケーションを構築する開発者にとって貴重なツールです。

IronPDFは、PDFを生成するための柔軟で使いやすいソリューションを提供します。 IronPDFのさまざまな機能に関する追加情報については、IronPDFドキュメントページをご覧ください。

IronPDFの永続ライセンスは、コーディングスキルを向上させ、現代のアプリケーション要件を達成するのに役立ちます。

RestSharpとIronPDFの両方を知っていることは、開発者が現代のアプリケーションを作成するための優れたスキルを追加します。

よくある質問

C# で HTML を PDF に変換するにはどうすればいいですか?

IronPDF の RenderHtmlAsPdf メソッドを使用して、HTML 文字列を PDF に変換できます。RenderHtmlFileAsPdf を使用して HTML ファイルを PDF に変換することもできます。

C#におけるRestSharpとは何ですか？

RestSharpはC#でHTTPリクエストを行うための人気のあるオープンソース for .NETライブラリです。RESTful APIとの作業を簡素化し、ウェブサービスと柔軟にやりとりできます。

C#プロジェクトにRestSharpをインストールするにはどうすればいいですか？

RestSharpはNuGetパッケージとしてC#プロジェクトにインストールできます。NuGetパッケージマネージャーコンソールでInstall-Package RestSharpコマンドを使用するか、Visual StudioのNuGetパッケージマネージャーUIを通じて行えます。

C#を使用してAPIデータからPDFを生成するにはどうすればいいですか？

RestSharpを使用してAPIからデータを取得し、IronPDFを使用してそのデータをPDFに変換することができます。最初にRestSharpを使ってデータを取得し、そのデータをHTMLにフォーマットした後、IronPDFを使用してPDFに変換します。

RestSharpにおけるエラーハンドリングのベストプラクティスは何ですか？

RestSharpは、応答状況を確認し、例外を処理することでエラーハンドリングのメカニズムを提供します。リクエストが成功したかエラーが発生したかを判断するために、ResponseStatusとStatusCodeプロパティを調査できます。

RestSharpのレスポンスでJSONデータを扱うにはどうすればよいですか？

RestSharpはレスポンス中のJSONデータを簡単に扱えます。System.Text.JsonやNewtonsoft.Jsonのようなライブラリを使用して、JSONコンテンツをC#オブジェクトにデシリアライズできます。

C#でURLをPDFに変換できますか？

はい、IronPDFを使用すると、RenderUrlAsPdfメソッドを使ってウェブURLを取得し、そのコンテンツをPDFドキュメントに変換することができます。

RestSharpを使用してPOSTリクエストでデータを送信するにはどうすればいいですか？

RestSharpでPOSTリクエストを送信するために、新しいオブジェクトを作成し、それをJSONにシリアライズしてRestRequestのAddJsonBodyメソッドを使用してリクエスト本文に含めます。その後、クライアントを使ってPOSTリクエストを実行します。

RestSharpは認証をサポートしていますか？

はい、RestSharpは認証付きのリクエスト送信をサポートしています。HttpBasicAuthenticatorを使用するような基本認証を含む認証パラメータをRestClientOptionsに含めることができます。

C#アプリケーションにPDF生成を統合するにはどうすれば良いですか？

IronPDFを使用してC#アプリケーションにPDF生成を統合できます。HTMLコンテンツ、URL、またはHTMLファイルをPDFに変換することができるため、レポート、ドキュメント、または請求書をアプリケーション内で直接生成することに役立ちます。

Jacob Mellor、Ironチームの最高技術責任者（CTO）
Jacob Mellor
  今すぐエンジニアリングチームとチャット
最高技術責任者（CTO）

ジェイコブ・メラーはIron Softwareの最高技術責任者（CTO）であり、C# PDFテクノロジーを開拓する先見的なエンジニアです。Iron Softwareのコアコードベースを支えるオリジナル開発者として、彼は創業以来、会社の製品アーキテクチャを形成し、CEOのCameron Rimingtonとともに、会社をNASA、Tesla、および世界的な政府機関にサービスを提供する50人以上の会社に変えました。1999年にロンドンで最初のソフトウェアビジネスを開業し、2005年に最初 for .NETコンポーネントを作成した後、Microsoftのエコシステム全体で複雑な問題を解決することを専門としました。

彼の主要なIronPDFとIron Suite .NETライブラリは、世界中で3000万以上のNuGetインストールを達成し、彼の基礎となるコードは世界中で使用されている開発者ツールに力を与え続けています。25年の商業経験と41年のコーディングの専門知識を持つJacobは、次世代の技術リーダーを指導しながら、エンタープライズグレードのC#、Java、Python PDFテクノロジーにおけるイノベーションの推進に注力しています。

関連する記事

30日間の無料体験 → 完全な製品。制限なし。クレジットカード不要。 無料トライアル

Iron Support Team

We're online 24 hours, 5 days a week.
Chat
Email
Call Me