RestEase C#（開發者使用指南）

RestEase 的特點

為了讓 C# 與 RESTful API 的互動更加容易，我們建立了一個稱為 RestEase 的強大且可適應的函式庫。 以下是其值得注意的幾項屬性：

基於介面的 API 定義：

RestEase 使用介面來定義 API 端點。 為了讓程式碼更易於閱讀和管理，這些介面的方法查詢屬性都會註明屬性，以識別 HTTP 方法、URL、標頭和其他請求資料。 介面上的方法對應於在介面上提出的要求。

HTTP 方法的屬性：

它直接在介面標頭和方法上提供屬性，例如 [Get]、[Post]、[Put]、[Delete] 等，以描述所提出的 HTTP 請求種類，確保提出適當的請求。

參數綁定：

對於請求建構的細粒度控制是透過屬性來提供的，例如 [Path]、[Query]、[Header] 和 [Body]，這些屬性分別用來將方法參數連結至 URL 路徑段、查詢字串、HTTP 標頭和請求體。

自動 JSON 序列化/反序列化：

RestEase 透過自動處理將請求與回應體序列化與反序列化為 JSON 來簡化資料處理。

異步支援：

Async 和 await 完全支援異步程式設計，可建立快速且反應迅速的應用程式。

可自訂的 HTTP 用戶端：

RestEase 的核心 HttpClient 可以自訂，以新增處理程式、變更逾時時間或設定其他參數，提供滿足特定需求的彈性。

錯誤處理：

您可以利用 RestEase 管理 HTTP 錯誤和回應的完整功能，開發強大的錯誤處理和重試邏輯。

查詢與路徑參數：

它允許複雜的查詢和路徑參數綁定，包括集合查詢映射和自訂物件。

預設值與可選參數：

參數可以是可選的，並指定預設值，這使得方法簽章和使用更簡單。

易於測試：

RestEase 透過介面定義 API，讓單元測試和模仿 HTTP 請求變得更容易，進而改善程式碼的可測試性和可維護性。

標頭與內容類型管理：

為了確保要求符合必要的標準，您可以毫不費力地設定和管理 HTTP 標頭，例如預設內容類型、標頭和自訂標頭。

依賴注入支援：

相依性注入框架和 RestEase 配合得很好，可以順利整合到當代 .NET 應用程式中。

建立與設定 RestEase C#；

Install-Package RestEase

using RestEase;
using System.Threading.Tasks;

// Define the API interface with RestEase attributes
public interface IApiService
{
    [Get("users/{id}")]
    Task<User> GetUserAsync([Path] int id);

    [Post("users")]
    Task<User> CreateUserAsync([Body] User user);

    [Put("users/{id}")]
    Task UpdateUserAsync([Path] int id, [Body] User user);

    [Delete("users/{id}")]
    Task DeleteUserAsync([Path] int id);
}

// Define the User class that models the data being worked with
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

using RestEase;
using System.Threading.Tasks;

// Define the API interface with RestEase attributes
public interface IApiService
{
    [Get("users/{id}")]
    Task<User> GetUserAsync([Path] int id);

    [Post("users")]
    Task<User> CreateUserAsync([Body] User user);

    [Put("users/{id}")]
    Task UpdateUserAsync([Path] int id, [Body] User user);

    [Delete("users/{id}")]
    Task DeleteUserAsync([Path] int id);
}

// Define the User class that models the data being worked with
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
}

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create a RestEase client instance
        var apiService = RestClient.For<IApiService>("https://api.example.com");

        // Example usage: Get a user by ID
        var user = await apiService.GetUserAsync(1);
        Console.WriteLine($"User: {user.Name}, Email: {user.Email}");

        // Example usage: Create a new user
        var newUser = new User { Name = "John Doe", Email = "john.doe@example.com" };
        var createdUser = await apiService.CreateUserAsync(newUser);
        Console.WriteLine($"Created User: {createdUser.Name}, Email: {createdUser.Email}");
    }
}

using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create a RestEase client instance
        var apiService = RestClient.For<IApiService>("https://api.example.com");

        // Example usage: Get a user by ID
        var user = await apiService.GetUserAsync(1);
        Console.WriteLine($"User: {user.Name}, Email: {user.Email}");

        // Example usage: Create a new user
        var newUser = new User { Name = "John Doe", Email = "john.doe@example.com" };
        var createdUser = await apiService.CreateUserAsync(newUser);
        Console.WriteLine($"Created User: {createdUser.Name}, Email: {createdUser.Email}");
    }
}

什麼是 IronPDF？

由於功能豐富的 .NET 函式庫 IronPDF 可讓 C# 程式建立、閱讀和編輯 PDF 文件。 開發人員可使用此應用程式從 HTML、CSS 和 JavaScript 內容快速建立可列印的高品質 PDF。 添加頁首和頁尾，分割和合併 PDF，為文件加上水印，以及將 HTML 轉換為 PDF 是其中最重要的工作。

IronPDF 同時支援 .NET Framework 和 .NET Core，因此適用範圍廣泛。 由於 PDF 內容豐富且易於使用，開發人員可以輕鬆地將其納入自己的產品中。 IronPdf 可以處理複雜的資料佈局和格式，因此其輸出的 PDF 與客戶的原始 HTML 文本非常相似。

IronPDF 擅長於 HTML 至 PDF 的轉換，可確保精確保留原始版面與樣式。 它非常適合從網頁內容（如報告、發票和文件）建立 PDF。 IronPDF 支援 HTML 檔案、URL 和原始 HTML 字串，可輕鬆製作高品質的 PDF 文件。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        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)
    {
        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");
    }
}

IronPDF 的特點

從 HTML 產生 PDF

將 HTML、CSS 及 JavaScript 轉換為 PDF。 IronPDF 支援兩個現代網路標準：媒體查詢和反應式設計。 它對現代網路標準的支援，對於使用 HTML 和 CSS 來動態裝飾 PDF 文件、報告和帳單來說非常方便。

PDF編輯

可以在已存在的 PDF 中加入文字、圖片和其他資料。 IronPDF 可以執行許多不同的任務，例如：從 PDF 檔案中擷取文字和圖片、將許多 PDF 合併為單一檔案、將 PDF 檔案分割為數個不同的文件，以及新增頁眉、頁腳、註解和水印。

PDF 轉檔

將 Word、Excel 和影像檔案等多種檔案類型轉換為 PDF。 IronPDF 支持将 PDF 转换为图像格式（PNG、JPEG 等）。

效能與可靠性

在工業環境中，高效能和高可靠性是理想的設計特質。 IronPdf 可輕鬆處理大型文件集。

安裝 IronPDF

安裝 IronPDF 套件，即可獲得在 .NET 專案中使用 PDF 所需的工具。

Install-Package IronPdf

將 RestEase 與 IronPDF 整合。

以下是一個範例，展示如何使用 RestEase 來呼叫 RESTful API 以及 IronPDF 來建立 PDF。 使用 RestEase，建立一個物件和介面，定義您想要呼叫的 API 端點。

using RestEase;
using System.Threading.Tasks;

// Define the API interface for RestEase
public interface IApiService
{
    [Get("api/data")]
    Task<ApiResponse> GetDataAsync();
}

// Class for holding API response
public class ApiResponse
{
    public string Data { get; set; }
}

using RestEase;
using System.Threading.Tasks;

// Define the API interface for RestEase
public interface IApiService
{
    [Get("api/data")]
    Task<ApiResponse> GetDataAsync();
}

// Class for holding API response
public class ApiResponse
{
    public string Data { get; set; }
}

若要將從 API 接收到的資料轉換成 PDF，請使用 IronPDF。

using IronPdf;
using System;
using System.IO;

// Class for generating PDFs
public class PdfGenerator
{
    // Method to generate a PDF from a string content
    public void GeneratePdf(string content)
    {
        var htmlContent = $"<html><body><h1>{content}</h1></body></html>";
        var renderer = new ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);

        // Save the PDF to the current directory as 'example.pdf'
        var pdfPath = Path.Combine(Directory.GetCurrentDirectory(), "example.pdf");
        pdfDocument.SaveAs(pdfPath);
        Console.WriteLine($"PDF generated and saved to {pdfPath}");
    }
}

using IronPdf;
using System;
using System.IO;

// Class for generating PDFs
public class PdfGenerator
{
    // Method to generate a PDF from a string content
    public void GeneratePdf(string content)
    {
        var htmlContent = $"<html><body><h1>{content}</h1></body></html>";
        var renderer = new ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);

        // Save the PDF to the current directory as 'example.pdf'
        var pdfPath = Path.Combine(Directory.GetCurrentDirectory(), "example.pdf");
        pdfDocument.SaveAs(pdfPath);
        Console.WriteLine($"PDF generated and saved to {pdfPath}");
    }
}

使用 IronPDF 根據 API 回應建立 PDF，並使用 RestEase 從主程式呼叫 API。

using System;
using RestEase;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create RestEase API client
        var apiService = RestClient.For<IApiService>("https://your-api-endpoint.com");
        var pdfGenerator = new PdfGenerator();

        try
        {
            // Get data from API
            var response = await apiService.GetDataAsync();
            // Generate PDF from the data
            pdfGenerator.GeneratePdf(response.Data);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

using System;
using RestEase;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // Create RestEase API client
        var apiService = RestClient.For<IApiService>("https://your-api-endpoint.com");
        var pdfGenerator = new PdfGenerator();

        try
        {
            // Get data from API
            var response = await apiService.GetDataAsync();
            // Generate PDF from the data
            pdfGenerator.GeneratePdf(response.Data);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"An error occurred: {ex.Message}");
        }
    }
}

在這個範例中，我們將教您如何使用 IronPDF 來 從 HTML 內容獲取的資料中建立 PDF，並使用 RestEase 來呼叫 RESTful API。 首先，我們使用 RestEase 定義一個名為 IApiService 的介面，並在其中指定所需的回應和 API 端點。 API 回應以 ApiResponse 類為模型。 接下來，我們開發一個 PdfGenerator 類，使用 IronPDF 將 HTML 資訊轉換為 PDF。 以下元素由主程式 Program.cs 結合而成。

為了使用 API，首先會建立 RestEase 客戶端的實例。 然後，它會異步取得資料串流，並利用 PdfGenerator 來依據資料建立並儲存 PDF。 本程式示範在 .NET 應用程式中整合 RestEase 用於 API 互動和 IronPDF 用於 PDF 製作，方法是使用 API 和回應資料建立 PDF 文件。