Penzle.Net

Penzle .Net SDK

Penzle .NET SDK是一个库，它允许开发人员轻松地与Penzle内容交付和内容管理API集成。该SDK专为想要从Penzle平台创建，更新和检索内容的.NET开发人员而设计。

入门

要安装Penzle .NET SDK，您可以使用以下选项：

• 在软件包管理器控制台中运行以下命令：

 Install-Package Penzle.Net

• 在命令行中运行以下.NET CLI命令：

 dotnet add <your project> package Penzle.Net

用法

要从Penzle API中检索内容，您将使用DeliveryPenzleClient类。该课程提供了从Penzle交付API中检索内容的方法。您将使用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客户端后，您可以从Penzle API中检索数据：

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

基于您在Penzle项目中定义的内容类型， GetEntries返回了强大的对象的集合。您可以使用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.GettingSted，以查看如何在控制台应用中使用各种方法的所有示例。

管理API

要在Penzle项目中创建，更新或删除数据，您需要使用Penzle Management API。 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]与我们联系。

我们期待收到您的来信！

贡献

我们欢迎对这个图书馆的贡献。如果您有兴趣贡献，请阅读贡献文件以获取有关如何开始的更多信息。