Penzle.Net

Penzle .Net Sdk

O Penzle .NET SDK é uma biblioteca que permite que os desenvolvedores se integrem facilmente às APIs de entrega de conteúdo e conteúdo do Penzle. Este SDK foi projetado para desenvolvedores .NET que desejam criar, atualizar e recuperar o conteúdo da plataforma Penzle.

Começando

Para instalar o Penzle .Net SDK, você pode usar as seguintes opções:

• Execute o seguinte comando no console do gerenciador de pacotes:

 Install-Package Penzle.Net

• Execute o seguinte comando .NET CLI na linha de comando:

 dotnet add <your project> package Penzle.Net

Uso

Para recuperar o conteúdo das APIs do Penzle, você usará a classe DeliveryPenzleClient . Esta classe fornece métodos para recuperar o conteúdo da API de entrega de Penzle. Você usará a classe ManagementPenzleClient para criar, atualizar e excluir conteúdo.

Você pode usar um cliente com DI/IOC ou sem DI/IOC.

Sem di/ioc

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

Com di/ioc

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

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

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

Recuperar dados

Depois de criar um cliente Penzle, você pode recuperar dados das APIs 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.
  

Crie um modelo de tipo forte que seja compatível com seu modelo de dados antes de fazer qualquer outra coisa.

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

Se você precisar de dados do sistema da entrada, adicione uma propriedade EntrySystem à classe.

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

O GetEntries retornam coleções de objetos fortemente tipo, com base nos tipos de conteúdo que você definiu no seu projeto Penzle. Você pode usar o LINQ para filtrar, classificar e transformar o conteúdo antes de ser retornado.

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

Você pode encontrar exemplos completos no projeto de console.NET 7, que é escrito em uma abordagem de "como fazer" para os desenvolvedores. Visite Penzle.net.GettingStarded para ver todos os exemplos de como usar vários métodos em aplicativos de console.

API de gerenciamento

Para criar, atualizar ou excluir dados em seu projeto Penzle, você precisará usar a API de gerenciamento da Penzle. O Penzle .NET SDK fornece uma classe ManagementPenzleClient que você pode usar para interagir com a API de gerenciamento:

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

Documentação do SDK

A documentação oficial do SDK fornece informações detalhadas sobre as várias classes e métodos disponíveis no SDK. Siga a documentação para obter mais detalhes.

Licença

Este SDK é liberado sob a licença do MIT.

Alcance para nós

Congratulamo -nos com feedback, relatórios de bugs e solicitações de recursos.

Se precisar de ajuda com esta biblioteca, entre em contato com o suporte ao fornecedor.

Você também pode abrir um problema no repositório do GitHub ou enviar uma solicitação de tração com melhorias no código.

Se você tiver alguma dúvida ou sugestão, não hesite em entrar em contato conosco enviando um email para [email protected].

Estamos ansiosos para ouvir de você!

Contribuição

Congratulamo -nos com contribuições para esta biblioteca. Se você estiver interessado em contribuir, leia o arquivo contribuinte para obter mais informações sobre como começar.