Penzle.Net

Penzle .net Sdk

Penzle .net SDK - это библиотека, которая позволяет разработчикам легко интегрироваться с API -интерфейсом по доставке контента Penzle и управлению контентом. Этот SDK предназначен для разработчиков .NET, которые хотят создавать, обновлять и получать контент с платформы Penzle.

Начиная

Чтобы установить Penzle .net SDK, вы можете использовать следующие параметры:

• Запустите следующую команду в консоли менеджера пакетов:

 Install-Package Penzle.Net

• Запустите следующую команду .NET CLI в командной строке:

 dotnet add <your project> package Penzle.Net

Использование

Чтобы получить контент из API Penzle, вы будете использовать класс DeliveryPenzleClient . Этот класс предоставляет методы для извлечения контента из API доставки Penzle. Вы будете использовать класс ManagementPenzleClient для создания, обновления и удаления контента.

Вы можете использовать клиента с DI/IOC или без DI/IOC.

Без DI/IOC

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

С DI/IOC

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

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

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

Получение данных

После создания клиента Penzle вы можете получить данные из 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.
  

Создайте сильную модель типа, которая сначала совместима с вашим шаблоном данных, прежде чем делать что -то еще.

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

Если вам нужны системные данные записи, добавьте в класс свойство начальной системой.

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

GetEntries возвращают коллекции объектов с сильным типом, основанные на типах контента, которые вы определили в своем проекте Penzle. Вы можете использовать LINQ для фильтрации, сортировки и преобразования контента до его возврата.

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

Вы можете найти полные примеры в консольном проекте .NET 7, который написан в подходе «Как» для разработчиков. Посетите penzle.net.gettingStarted, чтобы просмотреть все примеры того, как использовать различные методы в приложениях консоли.

Управление API

Чтобы создать, обновить или удалять данные в вашем проекте Penzle, вам необходимо использовать API управления Penzle. Penzle .net SDK предоставляет класс ManagementPenzleClient , который вы можете использовать для взаимодействия с API управления:

   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

Официальная документация SDK предоставляет подробную информацию о различных классах и методах, доступных в SDK. Пожалуйста, следуйте документации для получения более подробной информации.

Лицензия

Этот SDK выпускается по лицензии MIT.

Обратиться к нам

Мы приветствуем обратную связь, отчеты об ошибках и запросы функций.

Если вам нужна помощь с этой библиотекой, свяжитесь с поддержкой поставщика.

Вы также можете открыть проблему в репозитории GitHub или отправить запрос на привлечение с улучшениями кода.

Если у вас есть какие -либо вопросы или предложения, пожалуйста, не стесняйтесь обратиться к нам, отправив электронное письмо по адресу [email protected].

Мы с нетерпением ждем вашего ответа!

Вклад

Мы приветствуем вклад в эту библиотеку. Если вы заинтересованы в содействии, пожалуйста, прочитайте файл, чтобы получить дополнительную информацию о том, как начать.