Ocelot .NET (Funktionsweise für Entwickler)

Routing

Im Kern der Funktionalität von Ocelot steht seine Routing-Fähigkeit. Es gleicht eingehende Anfragen mit den entsprechenden Servicerouten aufgrund der von Entwicklern festgelegten Konfiguration ab und kann mit Service-Discovery-Mechanismen integriert werden. Dies beinhaltet die Unterstützung von Wildcard-Routing, was besonders nützlich ist, wenn es um unterschiedliche API-Versionen oder zahlreiche Serviceendpunkte geht.

Middleware / Delegierende Handler

Ocelot ermöglicht es Entwicklern, benutzerdefinierte Middleware oder Handler zu injizieren, die Anfragen und Antworten verarbeiten können, bevor sie den Client oder den Dienst erreichen. Dies ist nützlich für das Hinzufügen von Headern, das Protokollieren von Anfragen oder sogar das Ändern der Antwortstruktur nach Bedarf.

Lastausgleich

Ocelot unterstützt eine Vielzahl von Lastverteilungsstrategien von Haus aus, wie Round Robin, Least Connection und einen benutzerdefinierten Anbieter, wenn keine der vordefinierten Strategien die Anforderungen erfüllt. Diese Funktion stellt sicher, dass die Last gleichmäßig auf die verfügbaren Dienste verteilt wird, was die allgemeine Robustheit und Effizienz der Anwendung verbessert.

Authentifizierung und Autorisierung

Die Sicherung von API-Endpunkten ist kritisch, und Ocelot bietet Unterstützung für die Integration mit bestehenden Authentifizierungsanbietern wie Identity Server. Es unterstützt beliebte Authentifizierungsschemata, einschließlich JWT und OAuth2, und ermöglicht eine granulare Kontrolle über den Benutzerzugriff auf Dienste.

Rate Limiting und QoS

Die Ratenbegrenzung ist wichtig, um Missbrauch zu verhindern und eine faire Nutzung der Dienste zu gewährleisten, indem die Anzahl der Anfragen beschränkt wird, die ein Benutzer in einem bestimmten Zeitraum stellen kann. Quality of Service (QoS)-Optionen wie das Festlegen von Zeitlimits und Wiederholungen stellen sicher, dass Dienste unter verschiedenen Netzwerkbedingungen und Lasten verfügbar und reaktionsschnell bleiben.

Schritt 1: Einrichten der .NET Core Webanwendung

Erstellen Sie zuerst ein neues .NET Core-Web-API-Projekt. Sie können dies mit der .NET CLI oder Visual Studio machen.

Verwendung der .NET CLI:

dotnet new webapi -n OcelotWithIronPDF
cd OcelotWithIronPDF

dotnet new webapi -n OcelotWithIronPDF
cd OcelotWithIronPDF

Schritt 2: Hinzufügen notwendiger Pakete

Sie müssen Ocelot und IronPDF installieren. Sie können diese Pakete über NuGet hinzufügen.

dotnet add package Ocelot
dotnet add package IronPdf

dotnet add package Ocelot
dotnet add package IronPdf

Schritt 3: Ocelot konfigurieren

Fügen Sie eine ocelot.json-Datei zum Stamm Ihres Projekts hinzu, um das Routing von Ocelot zu konfigurieren. Diese Einrichtung geht davon aus, dass Ocelot PDF-Generierungsanfragen an einen bestimmten Pfad weiterleiten soll, der innerhalb der gleichen Anwendung von IronPDF behandelt wird.

{
    "ReRoutes": [
        {
            "DownstreamPathTemplate": "/api/pdf",
            "DownstreamScheme": "https",
            "DownstreamHostAndPorts": [
                {
                    "Host": "localhost",
                    "Port": 5001
                }
            ],
            "UpstreamPathTemplate": "/generatepdf",
            "UpstreamHttpMethod": ["Post"]
        }
    ],
    "GlobalConfiguration": {
        "BaseUrl": "http://localhost:5000"
    }
}

Schritt 4: Startup.cs konfigurieren

Aktualisieren Sie Startup.cs, um die Middleware von Ocelot einzuschließen. Stellen Sie sicher, dass Sie Ihre Anwendung auch zur Verwendung statischer Dateien konfigurieren, da IronPDF möglicherweise Assets vom lokalen Dateisystem laden muss.

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddOcelot();
    }

    public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();
        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });

        await app.UseOcelot();
    }
}

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddOcelot();
    }

    public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();
        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });

        await app.UseOcelot();
    }
}

Schritt 5: PDF-Erzeugung mit IronPDF implementieren

Erstellen Sie einen neuen Controller PdfController.cs in Ihrem Controller-Ordner. Dieser Controller wird die PDF-Generierungsanfragen bearbeiten.

using Microsoft.AspNetCore.Mvc;
using IronPdf;

namespace OcelotWithIronPDF.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class PdfController : ControllerBase
    {
        [HttpPost]
        public IActionResult CreatePdfFromHtml([FromBody] string htmlContent)
        {
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);
            var output = pdf.BinaryData;

            // Return the PDF as a file result
            return File(output, "application/pdf", "generated.pdf");
        }
    }
}

using Microsoft.AspNetCore.Mvc;
using IronPdf;

namespace OcelotWithIronPDF.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class PdfController : ControllerBase
    {
        [HttpPost]
        public IActionResult CreatePdfFromHtml([FromBody] string htmlContent)
        {
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);
            var output = pdf.BinaryData;

            // Return the PDF as a file result
            return File(output, "application/pdf", "generated.pdf");
        }
    }
}

Schritt 6: Ausführen der Anwendung

Stellen Sie sicher, dass Ihre Anwendung richtig konfiguriert ist, um auf den in ocelot.json angegebenen Ports zu lauschen. Sie können dies in Properties/launchSettings.json festlegen.

{
  "profiles": {
    "OcelotWithIronPDF": {
      "commandName": "Project",
      "launchBrowser": false,
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

Führen Sie nun Ihre Anwendung aus, und Sie sollten in der Lage sein, HTML-Inhalte an http://localhost:5000/generatepdf zu senden und ein PDF als Antwort zu erhalten.

Dieses Beispiel zeigt eine grundlegende Implementierung von Ocelot mit IronPDF innerhalb der gleichen Anwendung. Für Produktionsszenarien sollten Sie in Erwägung ziehen, Ihre Endpunkte zu sichern, Fehlerszenarien zu behandeln und den PDF-Erstellungsprozess gemäß Ihren spezifischen Anforderungen zu optimieren.