Flurl C# (jak to działa dla programistów)

Interfejs płynny

Płynna, łańcuchowa składnia zapewniana przez Flurl poprawia czytelność i łatwość utrzymania kodu. Programiści mogą tworzyć proste i wyraziste żądania HTTP oraz pracować z adresami URL, parametrami zapytania, nagłówkami i danymi.

Obsługa metod HTTP

Obsługiwane są wszystkie standardowe metody HTTP, w tym GET, POST, PUT, DELETE, PATCH, HEAD i OPTIONS. Dzięki takiemu kompleksowemu podejściu do wsparcia programiści mogą realizować różne zadania podczas pracy z interfejsami API sieci Web.

Obsługa parametrów zapytania

Flurl oferuje proste sposoby modyfikowania, dodawania i usuwania parametrów zapytania w adresach URL. Ułatwia to tworzenie dynamicznych adresów URL na podstawie danych wprowadzonych przez użytkownika lub sytuacji w czasie wykonywania.

Obsługa JSON

Obsługa danych JSON jest natywnie obsługiwana przez Flurl. Może z łatwością deserializować odpowiedzi JSON do obiektów C# oraz serializować obiekty do formatu JSON na potrzeby ładunków żądań. Dzięki temu korzystanie z interfejsów API opartych na JSON jest proste i łatwe.

Obsługa danych formularzy i przesyłania wieloczęściowego

Ułatwia to zarządzanie żądaniami wieloczęściowymi i danymi formularzy. Flurl ułatwia programistom dołączanie ładunków typu multipart/form-data lub danych zakodowanych w formularzach do żądań HTTP.

Obsługa błędów i zasady ponawiania prób

Flurl oferuje definiowanie zasad ponawiania prób oraz funkcje obsługi błędów dla wszystkich wywołań HTTP. Definiując unikalną logikę obsługi błędów lub techniki ponawiania prób, programiści mogą zwiększyć odporność i niezawodność wywołań API oraz interakcji. Zapewnia to również ochronę i pomaga programistom zapobiegać błędom anonimowych obiektów w odpowiedziach.

Uwierzytelnianie

Obsługuje kilka popularnych metod uwierzytelniania dla interfejsów API, w tym OAuth, niestandardowe schematy uwierzytelniania, uwierzytelnianie podstawowe oraz klucze API. Zapewnia to bezpieczną komunikację z interfejsami API wymagającymi uwierzytelnienia.

Testing Support

By isolating HTTP-related logic into reusable components with a distinct separation of concerns, Flurl encourages testability. This makes writing unit tests for API interactions simpler, as no real network calls are required to test them.

Configuration Flexibility

It provides configuration flexibility for HTTP clients and request parameters. Developers can change client behaviors, timeouts, error response amounts, headers, and other settings to meet the needs of particular applications or API limitations.

Rozszerzalność

Because of its framework for plugins, Flurl is very extendable. Developers can increase the platform's functionality by building unique extensions or incorporating third-party plugins for more features.

Create a New Visual Studio Project

Install-Package Flurl.Http

using Flurl;
using Flurl.Http;

// Configure a FlurlClient instance with base URL and headers
FlurlClient flurlClient = new FlurlClient("https://api.example.com/");
flurlClient.WithHeader("Authorization", "Bearer YourAccessTokenHere");

using Flurl;
using Flurl.Http;

// Configure a FlurlClient instance with base URL and headers
FlurlClient flurlClient = new FlurlClient("https://api.example.com/");
flurlClient.WithHeader("Authorization", "Bearer YourAccessTokenHere");

Imports Flurl
Imports Flurl.Http

' Configure a FlurlClient instance with base URL and headers
Private flurlClient As New FlurlClient("https://api.example.com/")
flurlClient.WithHeader("Authorization", "Bearer YourAccessTokenHere")

var response = await "http://localhost:5013/users".GetAsync();
Console.WriteLine(response.ToString());

if (response.ResponseMessage.IsSuccessStatusCode)
{
    var result = await response.ResponseMessage.Content.ReadAsStringAsync();
    Console.WriteLine(result);
}
else
{
    Console.WriteLine($"Error: {response.StatusCode}");
}

var response = await "http://localhost:5013/users".GetAsync();
Console.WriteLine(response.ToString());

if (response.ResponseMessage.IsSuccessStatusCode)
{
    var result = await response.ResponseMessage.Content.ReadAsStringAsync();
    Console.WriteLine(result);
}
else
{
    Console.WriteLine($"Error: {response.StatusCode}");
}

Dim response = await "http://localhost:5013/users".GetAsync()
Console.WriteLine(response.ToString())

If response.ResponseMessage.IsSuccessStatusCode Then
	Dim result = Await response.ResponseMessage.Content.ReadAsStringAsync()
	Console.WriteLine(result)
Else
	Console.WriteLine($"Error: {response.StatusCode}")
End If

// Handling JSON response
var responseObject = await "https://api.example.com/resource"
    .WithClient(flurlClient)
    .GetJsonAsync<ResponseType>();
// Assuming ResponseType is a class representing the expected JSON structure
Console.WriteLine($"Response: {responseObject.Property}");

// Handling JSON response
var responseObject = await "https://api.example.com/resource"
    .WithClient(flurlClient)
    .GetJsonAsync<ResponseType>();
// Assuming ResponseType is a class representing the expected JSON structure
Console.WriteLine($"Response: {responseObject.Property}");

Imports System
Imports Flurl.Http

' Handling JSON response
Dim responseObject As ResponseType = Await "https://api.example.com/resource" _
    .WithClient(flurlClient) _
    .GetJsonAsync(Of ResponseType)()
' Assuming ResponseType is a class representing the expected JSON structure
Console.WriteLine($"Response: {responseObject.Property}")

What is IronPDF?

A feature-rich .NET library named IronPDF is available in C# programs to create, read, and modify PDF documents. With the help of this tool, developers can quickly generate print-ready, high-quality PDFs from HTML, CSS, and JavaScript content. Some essential capabilities include the capacity to watermark, make headers and footers, split and combine PDFs, and convert HTML to PDF. IronPDF supports the .NET Framework and .NET Core, making it useful for various applications.

Because PDFs are simple to integrate and have a wealth of detailed documentation, developers may easily employ them in their applications. IronPDF ensures that the generated PDFs closely resemble the source HTML content by efficiently handling complicated layouts and styling.

IronPDF makes it super simple to convert webpages, URLs, and HTML into high-quality PDFs that look exactly like the original content. It's perfect for creating PDFs of online reports, invoices, and more. If you've been looking for a way to turn HTML to PDF, IronPDF has you covered!

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

Funkcje IronPDF

Generowanie plików PDF z HTML

Konwertuj JavaScript, HTML i CSS do formatu PDF. It supports media queries and responsive design, two contemporary web standards. It is useful for dynamically decorating PDF reports, invoices, and documents with HTML and CSS.

Edycja plików PDF

Text, photos, and other content can be added to preexisting PDFs. Text and pictures can be removed from PDF files. Numerous PDFs can be combined into one file. PDF files can be divided into multiple separate papers. Watermarks, annotations, headers, and footers can be included.

Konwersja plików PDF

Convert several file kinds, including Word, Excel, and picture files, to PDF format. PDF to image conversion (PNG, JPEG, etc.).

Wydajność i niezawodność

High performance and dependability are desired design qualities in industrial settings as they can manage extensive document collections effectively.

Zainstaluj IronPDF

To gain the tools you need to work with PDFs in .NET projects, install the IronPDF package.

Install-Package IronPdf

Fetch Data Using Flurl to generate a PDF

To make HTTP queries and get data from your API, use Flurl's fluent API. This is an instance of retrieving JSON data:

using Flurl;
using Flurl.Http;
using IronPdf;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            var response = await "http://localhost:5013/users/1".GetJsonAsync<User>();
            var id = response?.Id;
            var name = response?.Name;
            Console.WriteLine($"Data fetched successfully: {name}");

            // Generate PDF using IronPDF
            var renderer = new ChromePdfRenderer();
            string htmlTemplate = $@"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>";

            // Generate PDF document from HTML template
            var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);

            // Save or stream the PDF document
            pdfDocument.SaveAs(@"document.pdf");
            Console.WriteLine("PDF document generated successfully.");
        }
        catch (FlurlHttpException ex)
        {
            Console.WriteLine($"HTTP Error: {ex.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

// Example model class for JSON deserialization
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

using Flurl;
using Flurl.Http;
using IronPdf;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            var response = await "http://localhost:5013/users/1".GetJsonAsync<User>();
            var id = response?.Id;
            var name = response?.Name;
            Console.WriteLine($"Data fetched successfully: {name}");

            // Generate PDF using IronPDF
            var renderer = new ChromePdfRenderer();
            string htmlTemplate = $@"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>";

            // Generate PDF document from HTML template
            var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);

            // Save or stream the PDF document
            pdfDocument.SaveAs(@"document.pdf");
            Console.WriteLine("PDF document generated successfully.");
        }
        catch (FlurlHttpException ex)
        {
            Console.WriteLine($"HTTP Error: {ex.Message}");
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}

// Example model class for JSON deserialization
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

Imports Flurl
Imports Flurl.Http
Imports IronPdf
Imports System
Imports System.Threading.Tasks

Friend Class Program
	Shared Async Function Main(ByVal args() As String) As Task
		Try
			Dim response = await "http://localhost:5013/users/1".GetJsonAsync(Of User)()
			Dim id = response?.Id
			Dim name = response?.Name
			Console.WriteLine($"Data fetched successfully: {name}")

			' Generate PDF using IronPDF
			Dim renderer = New ChromePdfRenderer()
			Dim htmlTemplate As String = $"
                <html>
                <body>
                    <h1>{id}</h1>
                    <p>{name}</p>
                </body>
                </html>"

			' Generate PDF document from HTML template
			Dim pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate)

			' Save or stream the PDF document
			pdfDocument.SaveAs("document.pdf")
			Console.WriteLine("PDF document generated successfully.")
		Catch ex As FlurlHttpException
			Console.WriteLine($"HTTP Error: {ex.Message}")
		Catch ex As Exception
			Console.WriteLine($"Error: {ex.Message}")
		End Try
	End Function
End Class

' Example model class for JSON deserialization
Public Class User
	Public Property Id() As Integer
	Public Property Name() As String
End Class

In this example, Flurl's .GetJsonAsync() function is used to send a GET request and fetch JSON data. Replace User with your model class, which represents the API response structure, and "URL" with your actual API endpoint. An HTML template (htmlTemplate) can be rendered into a PDF document using IronPDF's ChromePdfRenderer class. Here, the title and body data retrieved from the API are used to dynamically construct the HTML template. The created PDF document (pdfDocument) is saved to the specified location ("document.pdf") on the file system. Modify the path as needed.

Provide robust error handling for problems like network faults (FlurlHttpException) or general exceptions (Exception) during data fetching or PDF production. You can change the page size, margins, headers, footers, and other PDF settings using IronPDF. For more advanced customization possibilities, see IronPDF's manner manual. When sending HTTP queries to APIs, ensure sensitive data and access tokens are handled securely. Use the proper authentication methods that your API requires.