Penzle.Net

Penzle .net SDK

El Penzle .NET SDK es una biblioteca que permite a los desarrolladores integrarse fácilmente con las API de entrega de contenido de Penzle y administración de contenido. Este SDK está diseñado para desarrolladores de .NET que desean crear, actualizar y recuperar contenido de la plataforma Penzle.

Empezando

Para instalar el SDK de Penzle .NET, puede usar las siguientes opciones:

• Ejecute el siguiente comando en la consola del administrador de paquetes:

 Install-Package Penzle.Net

• Ejecute el siguiente comando .NET CLI en la línea de comandos:

 dotnet add <your project> package Penzle.Net

Uso

Para recuperar el contenido de las API de Penzle, utilizará la clase de DeliveryPenzleClient . Esta clase proporciona métodos para recuperar contenido de la API de entrega de Penzle. Utilizará la clase ManagementPenzleClient para crear, actualizar y eliminar contenido.

Puede usar un cliente con DI/IOC o sin DI/IOC.

Sin DI/IOC

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

Con di/IOC

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

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

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

Recuperar datos

Después de crear un cliente Penzle, puede recuperar datos de las API de 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.
  

Cree un modelo de tipo fuerte que sea compatible con su plantilla de datos primero antes de hacer cualquier otra cosa.

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

Si necesita datos del sistema de la entrada, agregue una propiedad EntrySystem a la clase.

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

Las colecciones de retorno GetEntries de objetos fuertemente tipados, basados ​​en los tipos de contenido que ha definido en su proyecto Penzle. Puede usar LINQ para filtrar, clasificar y transformar el contenido antes de devolverlo.

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

Puede encontrar ejemplos completos en el proyecto de la consola.net 7, que está escrito en un enfoque "Cómo" para los desarrolladores. Visite penzle.net. GettingStarted para ver todos los ejemplos de cómo usar varios métodos en aplicaciones de consola.

API de gestión

Para crear, actualizar o eliminar datos en su proyecto Penzle, deberá usar la API de administración de Penzle. El SDK de Penzle .NET proporciona una clase ManagementPenzleClient que puede usar para interactuar con la API de administración:

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

Documentación de SDK

La documentación oficial de SDK proporciona información detallada sobre las diversas clases y métodos disponibles en el SDK. Siga la documentación para obtener más detalles.

Licencia

Este SDK se lanza bajo la licencia MIT.

Comuníquese con nosotros

Agradecemos comentarios, informes de errores y solicitudes de funciones.

Si necesita ayuda con esta biblioteca, comuníquese con el soporte del proveedor.

También puede abrir un problema en el repositorio de GitHub o enviar una solicitud de extracción con mejoras en el código.

Si tiene alguna pregunta o sugerencia, no dude en comunicarse con nosotros enviando un correo electrónico a [email protected].

¡Esperamos tener noticias tuyas!

Contribución

Agradecemos las contribuciones a esta biblioteca. Si está interesado en contribuir, lea el archivo que contribuye para obtener más información sobre cómo comenzar.