Penzle.Net

Penzle .net SDK

Das Penzle .NET SDK ist eine Bibliothek, mit der Entwickler einfach in die APIs von Penzle Content Delivery und Content Management integriert werden können. Dieser SDK ist für .NET -Entwickler konzipiert, die Inhalte von der Penzle -Plattform erstellen, aktualisieren und abrufen möchten.

Erste Schritte

Um den Penzle .NET SDK zu installieren, können Sie die folgenden Optionen verwenden:

• Führen Sie den folgenden Befehl in der Package Manager -Konsole aus:

 Install-Package Penzle.Net

• Führen Sie den folgenden .NET CLI-Befehl in der Befehlszeile aus:

 dotnet add <your project> package Penzle.Net

Verwendung

Um Inhalte von der Penzle -APIs abzurufen, verwenden Sie die DeliveryPenzleClient -Klasse. Diese Klasse enthält Methoden zum Abrufen von Inhalten von der Penzle -Liefer -API. Sie verwenden ManagementPenzleClient -Klasse, um Inhalte zu erstellen, zu aktualisieren und zu löschen.

Sie können einen Client mit DI/IOC oder ohne DI/IOC verwenden.

Ohne DI/IOC

   var client = DeliveryPenzleClient
          . Factory
          (
              apiDeliveryKey : "<delivery_api_key>" ,
              ( api ) =>
              {
                  api . Environment = "<environment_name>" ;
                  api . Project = "<project_name>" ;
              }
          ) ;

Mit di/ioc

    public void ConfigureServices ( IServiceCollection services )
    {
	    services . AddPenzleClient ( Configuration ) ;
    } 

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

	    public HomeController ( IDeliveryPenzleClient deliveryPenzleClient )
	    {
		    client = deliveryPenzleClient ;
	    }
    } 

Daten abrufen

Nach dem Erstellen eines Penzle -Clients können Sie Daten von Penzle APIs abrufen:

    // Retrieving a single entry by ID
    var entry = await client . Entry . GetEntry < Author > ( < author_id > ) ;
  
    Console . WriteLine ( entry . Summary ) ; // => Penzle author.
    Console . WriteLine ( entry . Age ) ; // => 27.
  

Erstellen Sie zuerst ein starkes Typmodell, das mit Ihrer Datenvorlage kompatibel ist, bevor Sie etwas anderes tun.

 public sealed class Author
{
    public string Summary { get ; set ; }
    public int Age { get ; set ; }
}

Wenn Sie Systemdaten des Eintrags benötigen, fügen Sie der Klasse eine Eintragssystemeigenschaft hinzu.

 public sealed class Author
{
    public EntrySystem System { get ; init ; }
    public string Summary { get ; set ; }
    public int Age { get ; set ; }
}

Die GetEntries Return-Sammlungen starker Objekte, basierend auf den Inhaltstypen, die Sie in Ihrem Penzle-Projekt definiert haben. Sie können LINQ verwenden, um den Inhalt zu filtern, zu sortieren und zu transformieren, bevor er zurückgegeben wird.

    // Use query builder to define request parameters.
    var query = QueryEntryBuilder . New
                . Where ( x => x . Summary . Contains ( "J" ) && x . Age >= 30 )
                . OrderBy ( x => x . Id )
                . Select ( x => new { x . Id , x . FirstName } ) ;
        
    var entries = await client . Entry . GetEntries < Author > ( query : query ) ;

  // Print the entries to the console.
    foreach ( var entry in entries )
    {
        // Print the entry system fields.
        Console . WriteLine ( value : $ "Summary { entry . Summary } " ) ;
        Console . WriteLine ( value : $ "Age: { entry . Age } " ) ;
    }

Sie können vollständige Beispiele im Projekt.NET 7 -Konsolenprojekt finden, das in einem "How To" -Ansatz für Entwickler geschrieben ist. Besuchen Sie penzle.net.gettingStarted, um alle Beispiele für die Verwendung verschiedener Methoden in Konsolenanwendungen anzuzeigen.

Management -API

Um Daten in Ihrem Penzle -Projekt zu erstellen, zu aktualisieren oder zu löschen, müssen Sie die Penzle -Management -API verwenden. Der Penzle .NET SDK bietet eine ManagementPenzleClient -Klasse, mit der Sie mit der Management -API interagieren können:

   var client = ManagementPenzleClient
          . Factory
          (
              apiManagementKey : "<management_api_key>"
          ) ; 

    // Create a new instance of the form entry.
    var author = new Author
    {
        Summary = "David Smith" ,
        Age = 20 ,
    } ;

    // Create a new instance of the entry.
    var medicalReleaseId = await client . Entry . CreateEntry ( author , CancellationToken . None ) ; 

SDK -Dokumentation

Die offizielle SDK -Dokumentation enthält detaillierte Informationen zu den verschiedenen Klassen und Methoden im SDK. Bitte befolgen Sie die Dokumentation, um weitere Informationen zu erhalten.

Lizenz

Dieser SDK wird unter der MIT -Lizenz veröffentlicht.

Greifen Sie an uns

Wir begrüßen Feedback, Fehlerberichte und Feature -Anfragen.

Wenn Sie Hilfe in dieser Bibliothek benötigen, wenden Sie sich bitte an den Lieferantenunterstützung.

Sie können auch ein Problem im GitHub -Repository eröffnen oder eine Pull -Anfrage mit Verbesserungen des Codes einreichen.

Wenn Sie Fragen oder Vorschläge haben, wenden Sie sich bitte an uns, indem Sie eine E -Mail an [email protected] senden.

Wir freuen uns, von Ihnen zu hören!

Beitrag

Wir begrüßen Beiträge zu dieser Bibliothek. Wenn Sie an einem Beitrag interessiert sind, lesen Sie bitte die beitragende Datei, um weitere Informationen zum Einstieg zu erhalten.