Penzle.Net

Penzle .net SDK

Le Penzle .NET SDK est une bibliothèque qui permet aux développeurs de s'intégrer facilement aux API de livraison de contenu Penzle et de gestion du contenu. Ce SDK est conçu pour les développeurs .NET qui souhaitent créer, mettre à jour et récupérer du contenu à partir de la plate-forme Penzle.

Commencer

Pour installer le SDK Penzle .net, vous pouvez utiliser les options suivantes:

• Exécutez la commande suivante dans la console du gestionnaire de packages:

 Install-Package Penzle.Net

• Exécutez la commande .net CLI suivante dans la ligne de commande:

 dotnet add <your project> package Penzle.Net

Usage

Pour récupérer le contenu des API Penzle, vous utiliserez la classe DeliveryPenzleClient . Cette classe fournit des méthodes pour récupérer le contenu de l'API de livraison Penzle. Vous utiliserez la classe ManagementPenzleClient pour créer, mettre à jour et supprimer du contenu.

Vous pouvez utiliser un client avec DI / IOC ou sans DI / IOC.

Sans DI / IOC

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

Avec DI / IOC

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

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

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

Récupération des données

Après avoir créé un client Penzle, vous pouvez récupérer des données à partir des API Penzle:

    // 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.
  

Créez un modèle de type fort compatible avec votre modèle de données avant de faire quoi que ce soit d'autre.

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

Si vous avez besoin de données système de l'entrée, ajoutez une propriété EntrySystem à la classe.

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

Les GetEntries retournent des collections d'objets fortement typés, en fonction des types de contenu que vous avez définis dans votre projet Penzle. Vous pouvez utiliser LINQ pour filtrer, trier et transformer le contenu avant son retour.

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

Vous pouvez trouver des exemples complets dans le projet de console.net 7, qui est écrit dans une approche "comment" pour les développeurs. Visitez Penzle.net.tartingStarted pour afficher tous les exemples d'utilisation de diverses méthodes dans les applications de console.

API de gestion

Pour créer, mettre à jour ou supprimer des données dans votre projet Penzle, vous devrez utiliser l'API de gestion de Penzle. Le Penzle .NET SDK fournit une classe ManagementPenzleClient que vous pouvez utiliser pour interagir avec l'API de gestion:

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

Documentation SDK

La documentation officielle du SDK fournit des informations détaillées sur les différentes classes et méthodes disponibles dans le SDK. Veuillez suivre la documentation pour plus de détails.

Licence

Ce SDK est libéré sous la licence du MIT.

Tendre la main à nous

Nous accueillons les commentaires, les rapports de bogues et les demandes de fonctionnalités.

Si vous avez besoin d'aide avec cette bibliothèque, veuillez contacter l'assistance du fournisseur.

Vous pouvez également ouvrir un problème sur le référentiel GitHub ou soumettre une demande de traction avec des améliorations au code.

Si vous avez des questions ou des suggestions, n'hésitez pas à nous contacter en envoyant un e-mail à [email protected].

Nous avons hâte de vous entendre!

Contribution

Nous saluons les contributions à cette bibliothèque. Si vous souhaitez contribuer, veuillez lire le fichier contributif pour plus d'informations sur la façon de commencer.