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

RestEase Özellikleri

C#'da RESTful API'lerle etkileşimi kolaylaştırmak için oluşturulmuş sağlam ve uyarlanabilir bir kütüphane olan RestEase, etkileşimleri kolaylaştırır. İşte onun dikkat çekici özelliklerinden birkaçı:

Arayüze Dayalı API Tanımları:

API uç noktalarını tanımlamak için RestEase arayüzler kullanır. Bu arayüzlerin yöntem sorgu özellikleri, HTTP yöntemlerini, URL'leri, başlıkları ve diğer istek verilerini tanımlayan özniteliklerle anotasyonu yapılır ve bu da kodun daha okunabilir ve yönetilebilir olmasını sağlar. Arayüz üzerindeki yöntemler, o isteklerde yapılan taleplerle eşleşir.

HTTP Yöntemleri için Öznitelikler:

Doğru isteklerin yapıldığından emin olunarak, yapılan HTTP isteğinin türünü anlatan [Get], [Post], [Put], [Delete] gibi arayüz başlıklarına ve metodlarına doğrudan özellikler sağlar.

Parametre Bağlama:

İsteğin oluşturulması üzerinde ayrıntılı kontrol, sırasıyla metod parametrelerini URL yol segmentlerine, sorgu dizelerine, HTTP başlıklarına ve istek gövdelerine bağlamak için kullanılan [Path], [Query], [Header] ve [Body] gibi özellikler aracılığıyla sağlanır.

Otomatik JSON Serileştirimi/Deserileştirimi:

RestEase, istek ve yanıt gövdelerinin JSON'a serileştirilmesini ve deserileştirilmesini otomatik olarak ele alarak veri işlemlerini basitleştirir.

Asenkron Destek:

Asenkron programlama için tam destek sunarak, hızlı ve yanıt veren uygulamalar oluşturulmasına olanak tanır.

Özelleştirilebilir HTTP İstemcileri:

RestEase'in çekirdek HttpClient'ı, belirli ihtiyaçları karşılamak için esneklik sağlayarak, işleyiciler eklemek, zaman aşımını değiştirmek veya diğer parametreleri ayarlamak için özelleştirilebilir.

Hata Yönetimi:

HTTP hatalarını ve yanıtlarını yönetmek için RestEase'in tam yetenekleri ile güçlü hata yönetimi ve yeniden deneme mantığı geliştirebilirsiniz.

Sorgu ve Yol Parametreleri:

Kapsamlı ve uyarlanabilir API etkileşimlerini sağlayarak, koleksiyonlar sorgu haritaları ve özel nesneler dahil, karmaşık sorgu ve yol parametresi bağlamasına izin verir.

Varsayılan Değerler ve İsteğe Bağlı Parametreler:

Parametreler isteğe bağlı yapılabilir ve varsayılan değerler belirtilmiş olabilir, bu da yöntem imzalarını ve kullanımını sadeleştirir.

Kolay Test:

Arayüzler aracılığıyla API'leri tanımlayarak, birim testlerini kolaylaştırır ve HTTP isteklerini taklit eder, bu da kodun test edilebilirliğini ve sürdürülebilirliğini artırır.

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

Gerekli kriterlere uygun olmasını sağlamak için isteklerin otomatik olarak içerik türleri, başlık ve özel başlıklar gibi HTTP başlıklarını ayarlamak ve yönetmek kolaydır.

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

Bağımlılık enjeksiyon çerçeveleri ve RestEase, modern .NET uygulamalarına sorunsuz entegrasyon sağlamak için iyi bir uyum içinde çalışır.

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 dosyaları oluşturabilir, okuyabilir ve düzenleyebilir. Geliştiriciler bu uygulamayı kullanarak HTML, CSS ve JavaScript içeriğinden hızlı bir şekilde baskıya hazır, yüksek kaliteli PDF'ler oluşturabilir. Başlıklar ve altbilgiler ekleme, PDF'leri bölme ve birleştirme, belgeleri filigranlama ve HTML'yi PDF'ye dönüştürme en önemli görevlerden bazılarıdır.

IronPDF, geniş bir uygulama yelpazesi için kullanılabilir hale getiren hem .NET Framework hem de .NET Core'u destekler. Geliştiriciler içeriğin zenginliğinden ve kullanım kolaylığından dolayı PDF'leri ürünlerine kolayca entegre edebilir. IronPDF, karmaşık veri düzenlerini ve formatlamayı yönettiğinden, çıktıda ürettiği PDF'ler, müşterinin orijinal HTML metnine oldukça benzemektedir.

IronPDF, HTML'den PDF'ye dönüşümde mükemmeldir, özgün düzenler ve stillerin hassas bir şekilde korunmasını sağlar. Raporlar, faturalar ve belgeler gibi web tabanlı içeriklerden PDF oluşturmak için mükemmeldir. HTML dosyaları, URL'ler ve ham HTML dizeleri için destekle, IronPDF yüksek kaliteli PDF belgelerini kolayca ü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 Özellikleri

HTML'den PDF Üretimi

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

PDF Düzenleme

Mevcut PDF'lere metin, resimler ve diğer materyalleri eklemek mümkündür. IronPDF, için birçok farklı görevi gerçekleştirebilir, PDF dosyalarından metin ve görüntü çıkarma, birçok PDF'yi tek bir dosya halinde birleştirme, PDF dosyalarını birkaç farklı belgeye bölme ve başlıklar, altbilgiler, açıklamalar ve filigranlar ekleme gibi.

PDF Dönüşümü

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

Performans ve Güvenilirlik

Endüstriyel ortamlarda yüksek performans ve güvenilirlik arzulanan tasarım özellikleridir. IronPDF, büyük belge kümelerini kolayca işler.

IronPDF Kurulumu

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

Install-Package IronPdf

RestEase ile IronPDF'i Entegre Etme

İşte RestEase kullanarak bir RESTful API'yi aramak ve IronPDF kullanarak bir PDF oluşturmak için bir örnek. RestEase kullanarak, aramak istediğiniz API uç noktalarını tanımlayan bir nesne ve bir 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 verileri PDF'ye dönüştürmek için IronPDF kullanın.

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

API yanıtına dayalı olarak PDF'yi oluşturmak için IronPDF'i ve ana programdan API'yi çağırmak için RestEase'i 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, IronPDF kullanarak HTML içeriğinden bir PDF oluşturmayı ve RestEase kullanarak RESTful bir API'yi çağırmayı gösteriyoruz. İlk olarak, istenen yanıtı ve API uç noktasını belirlediğimiz, IApiService adlı bir arayüzü tanımlamak için RestEase'i kullanıyoruz. Bir API yanıtı, ApiResponse sınıfı tarafından modellenir. Sonraki adımda, HTML bilgisini IronPDF kullanarak PDF'ye dönüştüren PdfGenerator sınıfını geliştiriyoruz. Ana program, Program.cs tarafından birleştirilen aşağıdaki öğeleri içerir.

API'yi kullanmak için, ilk olarak RestEase istemcisinin bir örneğini oluşturur. Daha sonra veriyi alır ve veriye bağlı olarak bir PDF oluşturup kaydetmek için PdfGenerator kullanır. Bu program, bir .NET uygulamasında API etkileşimi için RestEase ve PDF üretimi için IronPDF'in entegrasyonunu, bir API ve yanıt verileri kullanarak bir PDF belgesi oluşturmayı gösterir.