Penzle.Net

Penzle .net SDK

Penzle .net SDK adalah perpustakaan yang memungkinkan pengembang untuk dengan mudah berintegrasi dengan pengiriman konten Penzle dan API manajemen konten. SDK ini dirancang untuk pengembang .NET yang ingin membuat, memperbarui, dan mengambil konten dari platform Penzle.

Memulai

Untuk menginstal Penzle .net SDK, Anda dapat menggunakan opsi berikut:

• Jalankan perintah berikut di Konsol Manajer Paket:

 Install-Package Penzle.Net

• Jalankan perintah .net CLI berikut di baris perintah:

 dotnet add <your project> package Penzle.Net

Penggunaan

Untuk mengambil konten dari API Penzle, Anda akan menggunakan kelas DeliveryPenzleClient . Kelas ini menyediakan metode untuk mengambil konten dari Penzle Delivery API. Anda akan menggunakan kelas ManagementPenzleClient untuk membuat, memperbarui, dan menghapus konten.

Anda dapat menggunakan klien dengan DI/IOC atau tanpa DI/IOC.

Tanpa DI/IOC

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

Dengan DI/IOC

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

    public class HomeController
    {
	    private IDeliveryPenzleClient client ;

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

Mengambil data

Setelah membuat klien Penzle, Anda dapat mengambil data dari 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.
  

Buat model tipe yang kuat yang kompatibel dengan templat data Anda terlebih dahulu sebelum Anda melakukan hal lain.

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

Jika Anda memerlukan data sistem entri, tambahkan properti Entrysystem ke kelas.

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

GetEntries mengembalikan koleksi objek yang sangat diketik, berdasarkan jenis konten yang telah Anda tentukan dalam proyek Penzle Anda. Anda dapat menggunakan LINQ untuk memfilter, mengurutkan dan mengubah konten sebelum dikembalikan.

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

Anda dapat menemukan contoh lengkap dalam proyek konsol NET 7, yang ditulis dalam pendekatan "bagaimana" untuk pengembang. Kunjungi penzle.net.gettingsarted untuk melihat semua contoh cara menggunakan berbagai metode dalam aplikasi konsol.

API Manajemen

Untuk membuat, memperbarui atau menghapus data dalam proyek Penzle Anda, Anda perlu menggunakan API manajemen Penzle. Penzle .net SDK menyediakan kelas ManagementPenzleClient yang dapat Anda gunakan untuk berinteraksi dengan API manajemen:

   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 ) ; 

Dokumentasi SDK

Dokumentasi SDK resmi memberikan informasi terperinci tentang berbagai kelas dan metode yang tersedia di SDK. Harap ikuti dokumentasi untuk lebih jelasnya.

Lisensi

SDK ini dirilis di bawah lisensi MIT.

Menjangkau kami

Kami menyambut umpan balik, laporan bug, dan permintaan fitur.

Jika Anda memerlukan bantuan dengan perpustakaan ini, silakan hubungi dukungan vendor.

Anda juga dapat membuka masalah pada repositori GitHub atau mengirimkan permintaan tarik dengan peningkatan kode.

Jika Anda memiliki pertanyaan atau saran, jangan ragu untuk menghubungi kami dengan mengirim email ke [email protected].

Kami menantikan kabar dari Anda!

Kontribusi

Kami menyambut kontribusi untuk perpustakaan ini. Jika Anda tertarik untuk berkontribusi, silakan baca file yang berkontribusi untuk informasi lebih lanjut tentang cara memulai.