Referensi teknis untuk Proksi Dev

Bagian ini berisi referensi teknis untuk plugin dan opsi konfigurasi Dev Proxy.

Plugin mana yang harus saya gunakan untuk pelaporan dan analisis?

Gunakan tabel berikut untuk memilih plugin yang cocok dengan apa yang ingin Anda pelajari tentang lalu lintas API aplikasi Anda. Plugin yang menghasilkan laporan memerlukan reporter, seperti JsonReporter, MarkdownReporter, atau PlainTextReporter, untuk menyimpan laporan ke file. Plugin generator menulis file output mereka secara langsung. Dev Proxy membuat file output di direktori kerja saat ini setelah Anda berhenti merekam.

Maksud	Plugin + reporter	File keluaran
Inventarisasi URL yang dipanggil aplikasi saya	UrlDiscoveryPlugin + JsonReporter	UrlDiscoveryPlugin_JsonReporter.json
Jumlah permintaan dan hasilnya	ExecutionSummaryPlugin + MarkdownReporter atau JsonReporter	ExecutionSummaryPlugin_MarkdownReporter.md atau ExecutionSummaryPlugin_JsonReporter.json
Catat permintaan dan respons penuh	HarGeneratorPlugin	devproxy-yyyyMMddHHmmss.har
Buat permintaan yang dapat diputar ulang	HttpFileGeneratorPlugin	requests_yyyyMMddHHmmss.http
Buat spesifikasi API dari traffic	OpenApiSpecGeneratorPlugin atau TypeSpecGeneratorPlugin	host-port-yyyyMMddHHmmss.json (atau .yaml) per host API, atau name-yyyyMMddHHmmss.tsp per host API
Membuat mock dari trafik	MockGeneratorPlugin	mocks-yyyyMMddHHmmss.json
Temukan izin minimal yang dibutuhkan aplikasi saya	MinimalPermissionsPlugin + MarkdownReporter atau JsonReporter	MinimalPermissionsPlugin_MarkdownReporter.md atau MinimalPermissionsPlugin_JsonReporter.json

Note

Jika file laporan dengan nama yang sama sudah ada, aplikasi pelapor menambahkan tanda waktu ke nama file, misalnya UrlDiscoveryPlugin_JsonReporter_yyyyMMddHHmmss.json. Untuk API Microsoft Graph, gunakan GraphMinimalPermissionsPlugin untuk menemukan izin minimal.

Perangkat tambah

Daftar plugin yang berfungsi dengan API apa pun.

Nama	Deskripsi
AuthPlugin	Mensimulasikan autentikasi dan otorisasi menggunakan kunci API atau OAuth2.
DevToolsPlugin	Mengekspos pesan dari Dev Proxy, serta informasi tentang permintaan dan respons yang dicegat di Chrome DevTools. Mendukung HTTP dan STDIO.
CachingGuidancePlugin	Menampilkan peringatan saat Dev Proxy mencegat permintaan yang sama dalam waktu yang sudah ditentukan.
CrudApiPlugin	Mensimulasikan CRUD API dengan penyimpanan data dalam memori.
ExecutionSummaryPlugin	Membuat laporan ringkasan dari permintaan yang melewati proksi.
GenericRandomErrorPlugin	Gagal permintaan dengan kesalahan acak yang dipilih dari file yang berisi kesalahan yang ditidakan.
HarGeneratorPlugin	Menghasilkan file Arsip HTTP (HAR) dari permintaan dan respons yang disadap.
HttpFileGeneratorPlugin	Menghasilkan file HTTP dari permintaan dan respons yang disadap.
LanguageModelFailurePlugin	Mensimulasikan berbagai skenario kegagalan model bahasa untuk menguji ketahanan aplikasi yang bergantung pada model bahasa.
LanguageModelRateLimitingPlugin	Mensimulasikan pembatasan tarif berbasis token untuk API model bahasa dengan melacak konsumsi token prompt dan penyelesaian dalam jendela waktu yang dapat dikonfigurasi.
LatensiPlugin	Menunda respons dengan jumlah milidetik acak dari rentang yang dikonfigurasi. Mendukung HTTP dan STDIO.
MinimalCsomPermissionsPlugin	Mendeteksi izin minimal yang diperlukan untuk memanggil permintaan API SharePoint Client-Side Object Model (CSOM) yang direkam.
MinimalPermissionsPlugin	Mengembalikan izin minimal yang diperlukan untuk memanggil permintaan API yang direkam. Menggunakan informasi API dari folder lokal yang ditentukan.
MinimalPermissionsGuidancePlugin	Membandingkan izin yang digunakan dalam token JWT yang dikirim ke API dengan cakupan minimum yang diperlukan untuk permintaan yang direkam oleh proksi dan menunjukkan perbedaannya.
MockGeneratorPlugin	Menghasilkan tiruan Proksi Dev berdasarkan permintaan yang disadap.
MockRequestPlugin	Memungkinkan Anda mengeluarkan permintaan web menggunakan Dev Proxy.
MockResponsePlugin	Mensimulasikan respons.
MockStdioResponsePlugin	Mensimulasikan respons untuk aplikasi berbasis STDIO, seperti server MCP.
ODataPagingGuidancePlugin	Menampilkan peringatan saat proksi mencegat permintaan penomoran OData menggunakan URL yang sebelumnya belum dikembalikan di salah satu respons yang disadap.
OpenAIMockResponsePlugin	Mensimulasikan respons dari Azure OpenAI dan OpenAI menggunakan model bahasa lokal.
OpenAITelemetryPlugin	Menghasilkan data telemetri untuk permintaan API yang kompatibel dengan OpenAI.
OpenAIUsageDebuggingPlugin	Mencatat metrik penggunaan OpenAI API ke file CSV untuk tujuan debugging dan analisis.
OpenApiSpecGeneratorPlugin	Menghasilkan spesifikasi OpenAPI dari permintaan dan respons yang telah disadap.
RateLimitingPlugin	Mensimulasikan perilaku batas laju.
RetryAfterPlugin	Mensimulasikan header yang dikirim oleh API setelah pengendalian laju permintaan.
RewritePlugin	Menulis ulang permintaan.
TypeSpecGeneratorPlugin	Menghasilkan file TypeSpec dari permintaan dan respons yang disadap.
UrlDiscoveryPlugin	Membuat daftar URL yang telah disadap proksi.

Plugin untuk Azure API Center

Daftar plugin yang berfungsi dengan Azure API Center.

Nama	Deskripsi
ApiCenterMinimalPermissionsPlugin	Memeriksa apakah aplikasi menggunakan izin minimal untuk memanggil API. Menggunakan informasi API dari instans Azure API Center yang ditentukan.
ApiCenterOnboardingPlugin	Memeriksa apakah API yang digunakan dalam aplikasi terdaftar dalam instans Azure API Center yang ditentukan.
ApiCenterProductionVersionPlugin	Memeriksa apakah API yang digunakan dalam aplikasi adalah versi produksi API yang terdaftar dalam instans Azure API Center yang ditentukan.

Plugin Microsoft Entra

Daftar plugin yang berfungsi dengan Microsoft Entra API.

Nama	Deskripsi
EntraMockResponsePlugin	Mensimulasikan respons terhadap Microsoft Entra.

Plugin Microsoft Graph

Daftar plugin yang berfungsi dengan Microsoft Graph API.

Nama	Deskripsi
GraphBetaSupportGuidancePlugin	Menampilkan peringatan ketika proksi mendeteksi permintaan ke endpoint beta Microsoft Graph.
GraphClientRequestIdGuidancePlugin	Menampilkan tip saat permintaan ke Microsoft Graph API tidak menyertakan client-request-id header.
GraphConnectorGuidancePlugin	Memperlihatkan panduan kontekstual untuk bekerja dengan konektor Microsoft Graph.
GraphMinimalPermissionsPlugin	Mengembalikan daftar izin minimal yang diperlukan untuk permintaan Microsoft Graph yang dicatat oleh proxy.
GraphMinimalPermissionsGuidancePlugin	Membandingkan izin yang digunakan dalam token JWT yang dikirim ke Microsoft Graph dengan cakupan minimum yang diperlukan untuk permintaan yang direkam proksi dan menunjukkan perbedaannya.
GraphMockResponsePlugin	Mensimulasikan respons untuk API Microsoft Graph.
GraphRandomErrorPlugin	Gagal permintaan yang dibuat ke Microsoft Graph dengan kesalahan acak.
GraphSdkGuidancePlugin	Menampilkan petunjuk saat proksi mencegat permintaan ke Microsoft Graph yang tidak diterbitkan oleh Microsoft Graph SDK.
GraphSelectGuidancePlugin	Memperlihatkan peringatan saat proksi mencegat permintaan ke API Microsoft Graph yang tidak menyertakan $select parameter string kueri.
ODSPSearchGuidancePlugin	Memperlihatkan peringatan saat Dev Proxy mendeteksi permintaan ke API pencarian OneDrive dan SharePoint.

Wartawan

Daftar wartawan yang menghasilkan laporan dalam format yang berbeda.

Nama	Deskripsi
JsonReporter	Menghasilkan laporan dalam format JSON.
MarkdownReporter	Menghasilkan laporan dalam format Markdown.
PlainTextReporter	Menghasilkan laporan dalam format teks biasa.

Konfigurasi

Panduan opsi konfigurasi Proksi Pengembangan.

Nama	Deskripsi
devproxyrc	File konfigurasi untuk Dev Proxy.
API Proksi	API untuk berinteraksi dengan Dev Proxy secara terprogram.
Pengaturan proksi	Opsi konfigurasi untuk pengaturan proksi.