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 Delivery 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 ; }
}エントリのシステムデータが必要な場合は、entrysystemプロパティをクラスに追加します。
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 } " ) ;
}開発者向けの「方法」アプローチで書かれたThe.net 7 Console Projectで完全な例を見つけることができます。 Penzle.net.gettingStartedにアクセスして、コンソールアプリケーションでさまざまな方法を使用する方法のすべての例を表示します。
Penzleプロジェクトでデータを作成、更新、または削除するには、Penzle Management APIを使用する必要があります。 Penzle .NET SDKは、管理APIと対話するために使用できるManagementPenzleClientクラスを提供します。
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]にメールを送信して、お気軽にお問い合わせください。
ご連絡をお待ちしております!
この図書館への貢献を歓迎します。寄付に興味がある場合は、開始方法の詳細については、寄稿ファイルをお読みください。