RestEase C# (Geliştiriciler İçin Nasıl Çalışır)

RestEase Özellikleri

RestEase adında sağlam ve uyarlanabilir bir kütüphane, C# dilinde RESTful API'lerle etkileşimi kolaylaştırma amacıyla oluşturulmuştur. İşte dikkat çekici birkaç niteliği:

Arayüz-Tabanlı API Tanımlamaları:

RestEase, API uç noktalarını tanımlamak için arayüzleri kullanır. Kodun daha okunaklı ve yönetilebilir hale gelmesi için, bu arayüzlerin metot sorgu özellikleri, HTTP yöntemlerini, URL'leri, başlıkları ve diğer istek verilerini tanımlayan özniteliklerle belirtilir. Arayüz üzerindeki metotlar, üzerinde yapılan isteklere karşılık gelir.

HTTP Yöntemleri İçin Öznitelikler:

Yapılan HTTP isteğinin türünü tanımlamak ve uygun isteklerin yapılmasını sağlamak için, arayüz başlıkları ve yöntemleri üzerinde doğrudan [Get], [Post], [Put], [Delete] gibi nitelikler sağlar.

Parametre Bağlama:

İstek yapılandırılmasında ince ayar kontrolü, sırasıyla yöntem parametrelerini URL yol segmentlerine, sorgu dizgilerine, HTTP başlıklarına ve istek gövdelerine bağlamak için kullanılan [Path], [Query], [Header] ve [Body] gibi nitelikler aracılığıyla sağlanır.

Otomatik JSON Serileştirme/Serileştirme Çözme:

RestEase, istek ve yanıt gövdelerinin JSON'a serileştirilmesi ve seriden çıkartılması işlemlerini otomatik olarak ele alarak veri işlemeyi kolaylaştırır.

Eşzamansız Destek:

Eşzamansız programlama için async ve await tam olarak desteklenir ve hızlı ve duyarlı uygulamalar oluşturmanıza olanak tanır.

Özelleştirilebilir HTTP İstemcileri:

RestEase'in çekirdek HttpClient'ı, belirli ihtiyaçları karşılamak için işlemciler eklemek, zaman aşımı sürelerini değiştirmek veya diğer parametreleri ayarlamak amacıyla özelleştirilebilir.

Hata Yönetimi:

HTTP hatalarını ve yanıtlarını yönetmek için RestEase'in tam yeteneklerini kullanarak sağlam hata yönetimi ve yeniden deneme mantığı geliştirebilirsiniz.

Sorgu ve Yol Parametreleri:

Kapsamlı ve uyarlanabilir API etkileşimlerini olanaklı kılan, koleksiyonlar sorgu haritaları ve özel nesneler de dahil olmak üzere karmaşık sorgu ve yol parametre bağlamalarını sağlar.

Varsayılan Değerler ve Opsiyonel Parametreler:

Parametreler opsiyonel hale getirilebilir ve varsayılan değerler belirlenebilir; bu durum metot imzalarını ve kullanımını daha basit hale getirir.

Kolay Test Edilebilirlik:

RestEase, arayüzler aracılığıyla API'leri tanımlayarak HTTP isteklerini birim testi ve simülasyonu yapmayı kolaylaştırır, bu da kodun test edilebilirliğini ve bakımını artırır.

Başlıklar ve İçerik Türü Yönetimi:

Gerekli kriterlere uygun istekler yapıldığından emin olmak için varsayılan içerik türü, başlık ve özel başlıklar gibi HTTP başlıklarını kolaylıkla ayarlayabilir ve yönetebilirsiniz.

Bağımlılık Enjeksiyonu Desteği:

Bağımlılık enjeksiyonu çerçeveleriyle RestEase iyi çalışır ve modern .NET uygulamalarına sorunsuz entegrasyon sağlar.

Create and Configure 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; }
}

Imports RestEase
Imports System.Threading.Tasks

' Define the API interface with RestEase attributes
Public Interface IApiService
	<[Get]("users/{id}")>
	Function GetUserAsync(<Path> ByVal id As Integer) As Task(Of User)

	<Post("users")>
	Function CreateUserAsync(<Body> ByVal user As User) As Task(Of User)

	<Put("users/{id}")>
	Function UpdateUserAsync(<Path> ByVal id As Integer, <Body> ByVal user As User) As Task

	<Delete("users/{id}")>
	Function DeleteUserAsync(<Path> ByVal id As Integer) As Task
End Interface

' Define the User class that models the data being worked with
Public Class User
	Public Property Id() As Integer
	Public Property Name() As String
	Public Property Email() As String
End Class

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

Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		' Create a RestEase client instance
		Dim apiService = RestClient.For(Of IApiService)("https://api.example.com")

		' Example usage: Get a user by ID
		Dim user = Await apiService.GetUserAsync(1)
		Console.WriteLine($"User: {user.Name}, Email: {user.Email}")

		' Example usage: Create a new user
		Dim newUser = New User With {
			.Name = "John Doe",
			.Email = "john.doe@example.com"
		}
		Dim createdUser = Await apiService.CreateUserAsync(newUser)
		Console.WriteLine($"Created User: {createdUser.Name}, Email: {createdUser.Email}")
	End Function
End Class

IronPDF nedir?

C# programları, zengin özelliklere sahip .NET kütüphanesi IronPDF sayesinde PDF belgeleri oluşturabilir, okuyabilir ve düzenleyebilir. Geliştirici, bu uygulamayı kullanarak HTML, CSS ve JavaScript içeriğinden, baskı kalitesinde ve yüksek kaliteli PDF'leri hızla oluşturabilir. Başlık ve altbilgi ekleme, PDF'leri bölme ve birleştirme, belgeleri damgalama ve HTML'yi PDF'ye dönüştürme en önemli görevler arasındadır.

IronPDF hem .NET Framework hem de .NET Core'u destekler, bu da onu geniş bir uygulama yelpazesi için kullanışlı hale getirir. Gelişmiş içerikleri ve kullanım kolaylığı nedeniyle, geliştiriciler ürünlerine PDF'leri kolayca dahil edebilirler. IronPDF, karmaşık veri düzenlerini ve biçimlendirmeyi işleyebilir; bu nedenle, ürettiği PDF'ler, istemcinin orijinal HTML metnine yakından benzer.

HTML'den PDF'ye dönüştürmede IronPDF, özgün düzenlerin ve tarzların hassas korunmasını sağlamakta üstünlük sağlar. Web tabanlı içeriklerden, örneğin raporlar, faturalar ve belgeler gibi PDF'ler oluşturmak için mükemmeldir. HTML dosyaları, URL'ler ve ham HTML dizeleri desteği ile IronPDF kolaylıkla yüksek kaliteli PDF belgeler üretir.

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

Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

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

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

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class

IronPDF'nin Özellikleri

HTML'den PDF Üretimi

HTML, CSS ve JavaScript'i PDF'ye dönüştürün. IronPDF iki modern web standardını destekler: medya sorguları ve duyarlı tasarım. Modern web standartları desteği, PDF belgelerini, raporlarını ve faturalarını dinamik olarak biçimlendirmek için HTML ve CSS kullanımını kolaylaştırır.

PDF Düzenleme

Mevcut PDF'lere metin, resim ve diğer materyalleri eklemek mümkündür. IronPDF, PDF dosyalarından metin ve resim çıkarma, birden fazla PDF'yi tek bir dosyada birleştirme, PDF dosyalarını farklı belgelere bölme, başlık, altbilgi, ek açıklamalar ve damgalar ekleme gibi birçok farklı görevi yerine getirebilir.

PDF Dönüştürme

Word, Excel ve resim dosyaları gibi çeşitli dosya türlerini PDF'ye dönüştürün. IronPDF, PDF'yi resim formatına (PNG, JPEG, vb.) çevirme yeteneğini destekler.

Performans ve Güvenilirlik

Endüstriyel bağlamlarda, yüksek performans ve güvenilirlik arzu edilen tasarım özellikleridir. IronPDF büyük belge setlerini kolayca işler.

IronPDF Yükleyin

.NET projelerinde PDF ile çalışmak için gereken araçları edinmek için IronPDF paketini yükleyin.

Install-Package IronPdf

RestEase ve IronPDF'yi Entegre Edin

İşte RestEase kullanarak bir RESTful API'yi çağırma ve IronPDF ile bir PDF oluşturmayı gösteren bir örnek: RestEase kullanarak, aramak istediğiniz API sonuç noktalarını tanımlayan bir nesne ve arayüz oluşturun.

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

Imports RestEase
Imports System.Threading.Tasks

' Define the API interface for RestEase
Public Interface IApiService
	<[Get]("api/data")>
	Function GetDataAsync() As Task(Of ApiResponse)
End Interface

' Class for holding API response
Public Class ApiResponse
	Public Property Data() As String
End Class

API'den alınan veriyi PDF'ye çevirin

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

Imports IronPdf
Imports System
Imports System.IO

' Class for generating PDFs
Public Class PdfGenerator
	' Method to generate a PDF from a string content
	Public Sub GeneratePdf(ByVal content As String)
		Dim htmlContent = $"<html><body><h1>{content}</h1></body></html>"
		Dim renderer = New ChromePdfRenderer()
		Dim pdfDocument = renderer.RenderHtmlAsPdf(htmlContent)

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

IronPDF'yi kullanarak PDF oluşturun ve ana programdan API'yi çağırmak için RestEase kullanın.

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

Imports System
Imports RestEase
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		' Create RestEase API client
		Dim apiService = RestClient.For(Of IApiService)("https://your-api-endpoint.com")
		Dim pdfGenerator As New PdfGenerator()

		Try
			' Get data from API
			Dim response = Await apiService.GetDataAsync()
			' Generate PDF from the data
			pdfGenerator.GeneratePdf(response.Data)
		Catch ex As Exception
			Console.WriteLine($"An error occurred: {ex.Message}")
		End Try
	End Function
End Class

Bu örnekte, topladığınız verilerden HTML içeriğinden nasıl PDF oluşturabileceğinizi ve RestEase kullanarak RESTful API'yi nasıl çağırabileceğinizi gösteriyoruz. İlk olarak, istediğimiz yanıtı ve API uç noktasını belirttiğimiz, IApiService adlı bir arayüzü tanımlamak için RestEase'i kullanıyoruz. Bir API yanıtı ApiResponse sınıfı ile modellenir. Sonra, IronPDF kullanarak HTML bilgisini PDF'e dönüştüren bir PdfGenerator sınıfı geliştiriyoruz. Aşağıdaki öğeler, ana program olan Program.cs tarafından birleştirilir.

Önce, RestEase istemcisi örneğini oluşturarak API'yi kullanmak için başlatıyoruz. Daha sonra veri akışını asenkron olarak alır ve veriye dayalı bir PDF oluşturup kaydetmek için PdfGenerator kullanır. Bu program, bir .NET uygulamasında API etkileşimleri için RestEase entegrasyonu ve IronPDF'nin PDF oluşturması entegrasyonunu, bir PDF belgesini oluşturmak için API ve yanıt verisini kullanarak gösterir.