Arsitektur plugin

Plugin adalah kelas .NET yang terdaftar di Dev Proxy yang memperkenalkan perilaku Proksi Dev tertentu. Plugin dapat menawarkan panduan real time tentang penggunaan API, mensimulasikan perilaku API, menganalisis beberapa permintaan API, atau menghasilkan laporan. Dev Proxy memiliki tiga jenis plugin:

• mencegat plugin yang mencegat permintaan dan respons serta dapat menganalisis dan memodifikasinya
• melaporkan plugin yang berjalan berdasarkan permintaan direkam oleh Dev Proxy
• wartawan yang menghasilkan laporan berdasarkan data yang dikumpulkan oleh plugin pelaporan

Anda mendaftarkan plugin dalam file devproxyrc.json. File berisi daftar plugin untuk dimuat dan konfigurasinya.

Dev Proxy dilengkapi dengan kumpulan plugin dan Anda dapat membuat plugin kustom untuk memperluas fungsionalitas Proksi Dev agar sesuai dengan kebutuhan Anda.

Ketika Dev Proxy dimulai, ia memuat plugin yang diaktifkan dalam file konfigurasinya. Bergantung pada plugin mana yang Anda aktifkan, Dev Proxy dapat memberikan panduan, mensimulasikan perilaku API, atau menganalisis permintaan API. Bagian berikut menjelaskan cara kerja berbagai jenis plugin.

Mencegat plugin

Saat Dev Proxy mencegat permintaan yang cocok dengan salah satu URL dalam array urlsToWatch, dev Proxy memanggil setiap plugin penyadapan dalam urutan yang tercantum dalam file konfigurasi. Setiap plugin yang mencegat mewarisi dari kelas BaseProxyPlugin, dan dapat berlangganan peristiwa berikut:

• BeforeRequest - dimunculkan saat Dev Proxy mencegat permintaan
• BeforeResponse - dimunculkan setelah Dev Proxy menerima respons dari server
• AfterResponse - dimunculkan setelah Dev Proxy mengirimkan respons ke klien

Untuk setiap peristiwa ini, plugin dapat menentukan penanganan aktivitas. Di handler, plugin dapat menganalisis permintaan dan respons, dan memodifikasinya jika diperlukan. Ini juga dapat menghasilkan pesan panduan. Untuk melihat apa yang mungkin, lihat kode plugin yang disediakan dengan Dev Proxy.

Plugin pelaporan

Dev Proxy memungkinkan Anda merekam permintaan dan respons API. Anda biasanya menggunakan perekaman untuk melaporkan penggunaan API atau menganalisis beberapa permintaan API. Plugin pelaporan mewarisi dari kelas BaseReportingPlugin, dan mendaftarkan penanganan aktivitas dengan peristiwa AfterRecordingStop.

Saat Anda berhenti merekam, Dev Proxy menaikkan peristiwa AfterRecordingStop, meneruskan daftar permintaan dan respons yang direkam sebagai argumen ke penanganan aktivitas terdaftar. Plugin pelaporan kemudian dapat menganalisis data yang direkam dan menghasilkan objek laporan. Objek laporan adalah objek arbitrer yang ditentukan oleh plugin pelaporan. Plugin pelaporan menyimpan laporan dengan memanggil metode StoreReport.

Penting

Plugin pelaporan menghasilkan objek laporan, yang disimpan Dev Proxy dalam memori. Untuk mengonversi objek laporan ini menjadi laporan yang dapat dibaca pengguna, Anda harus mengaktifkan satu atau beberapa wartawan dalam file konfigurasi Proksi Dev.

Wartawan

Dev Proxy menggunakan reporter untuk mengonversi objek laporan yang dihasilkan oleh plugin pelaporan menjadi laporan yang dapat dibaca pengguna. Misalnya, MarkdownReporter mengonversi objek laporan menjadi file Markdown. Wartawan adalah plugin khusus yang mewarisi dari kelas BaseReporter. Mereka menerapkan metode GetReport, yang mengambil sebagai argumen laporan yang dibuat oleh plugin pelaporan dan mengonversinya menjadi string. String ini kemudian disimpan pada disk dengan mengikuti pola PluginName_ReporterName.ReporterExtension, misalnya: ApiCenterOnboardingPlugin_MarkdownReporter.md.

Penting

Karena wartawan bergantung pada objek laporan yang dihasilkan oleh plugin pelaporan, Anda harus mengaktifkan plugin pelaporan dalam file konfigurasi Proksi Dev setelah melaporkan plugin. Jika Anda mengaktifkannya sebelum melaporkan plugin, wartawan tidak akan memiliki data apa pun untuk dilaporkan.