Penzle .NET SDK是一個庫,它允許開發人員輕鬆地與Penzle內容交付和內容管理API集成。該SDK專為想要從Penzle平台創建,更新和檢索內容的.NET開發人員而設計。
要安裝Penzle .NET SDK,您可以使用以下選項:
Install-Package Penzle.Net
dotnet add <your project> package Penzle.Net
要從Penzle API中檢索內容,您將使用DeliveryPenzleClient類。該課程提供了從Penzle交付API中檢索內容的方法。您將使用ManagementPenzleClient類來創建,更新和刪除內容。
您可以使用具有DI/IOC的客戶端,也可以使用DI/IOC。
var client = DeliveryPenzleClient
. Factory
(
apiDeliveryKey : "<delivery_api_key>" ,
( api ) =>
{
api . Environment = "<environment_name>" ;
api . Project = "<project_name>" ;
}
) ; 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,以查看如何在控制台應用中使用各種方法的所有示例。
要在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根據MIT許可發布。
我們歡迎反饋,錯誤報告和功能請求。
如果您需要此庫的幫助,請聯繫供應商支持。
您還可以在GitHub存儲庫上打開問題,也可以提交有關代碼改進的拉動請求。
如果您有任何疑問或建議,請隨時通過發送電子郵件至[email protected]與我們聯繫。
我們期待收到您的來信!
我們歡迎對這個圖書館的貢獻。如果您有興趣貢獻,請閱讀貢獻文件以獲取有關如何開始的更多信息。