Penzle .NET SDK هي مكتبة تتيح للمطورين الاندماج بسهولة مع واجهات برمجة تطبيقات Penzle لتسليم المحتوى وإدارة المحتوى. تم تصميم SDK هذا لمطوري .NET الذين يرغبون في إنشاء المحتوى وتحديثه واسترداده من منصة Penzle.
لتثبيت Penzle .NET SDK ، يمكنك استخدام الخيارات التالية:
Install-Package Penzle.Net
dotnet add <your project> package Penzle.Net
لاسترداد المحتوى من APIs Penzle ، سوف تستخدم فئة DeliveryPenzleClient . يوفر هذا الفصل طرقًا لاسترداد المحتوى من API Penzle Delivery. سوف تستخدم فئة 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 Apis:
// 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 ، والذي يتم كتابته في نهج "How to" للمطورين. تفضل بزيارة penzle.net.gettingstarted لعرض جميع الأمثلة على كيفية استخدام طرق مختلفة في تطبيقات وحدة التحكم.
لإنشاء البيانات أو تحديثها أو حذفها في مشروع Penzle الخاص بك ، ستحتاج إلى استخدام Penzle Management API. يوفر Penzle .NET SDK فئة 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 تحت رخصة معهد ماساتشوستس للتكنولوجيا.
نرحب بالتعليقات وتقارير الأخطاء وطلبات الميزات.
إذا كنت بحاجة إلى مساعدة في هذه المكتبة ، فيرجى الاتصال بدعم البائع.
يمكنك أيضًا فتح مشكلة على مستودع GitHub أو إرسال طلب سحب مع تحسينات على الرمز.
إذا كان لديك أي أسئلة أو اقتراحات ، فلا تتردد في الوصول إلينا عن طريق إرسال بريد إلكتروني إلى [email protected].
نتطلع إلى الاستماع منك!
نرحب بالمساهمات في هذه المكتبة. إذا كنت مهتمًا بالمساهمة ، فيرجى قراءة الملف المساهم لمزيد من المعلومات حول كيفية البدء.