ApiCenterOnboardingPlugin

Memeriksa apakah API yang digunakan dalam aplikasi terdaftar dalam instans Azure API Center yang ditentukan.

Contoh konfigurasi

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterOnboardingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterOnboardingPlugin"
    }
  ],
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspace": "default",
    "createApicEntryForNewApis": true
  }
}

Properti konfigurasi

Harta benda	Deskripsi	Bawaan
createApicEntryForNewApis	Atur ke true agar Dev Proxy membuat entri API baru untuk API yang terdeteksi dan yang belum terdaftar di API Center. Saat diatur ke false Dev Proxy hanya mencantumkan API yang tidak terdaftar di prompt perintah.	true
resourceGroupName	Nama grup sumber daya tempat Azure API Center berada.	Tidak
serviceName	Nama instans Azure API Center yang harus digunakan Dev Proxy untuk memeriksa apakah API yang digunakan dalam aplikasi terdaftar.	Tidak
subscriptionId	ID langganan Azure tempat instans Azure API Center berada.	Tidak
workspace	Nama ruang kerja Azure API Center yang akan digunakan.	default

Opsi baris perintah

Tidak

Komentar

Plugin ApiCenterOnboardingPlugin memeriksa apakah API yang digunakan dalam aplikasi terdaftar dalam instans Azure API Center yang ditentukan. Jika API tidak terdaftar, plugin dapat membuat entri API baru di instans API Center.

Untuk menyambungkan ke Azure API Center, plugin menggunakan kredensial Azure (dalam urutan ini):

• Lingkungan
• Identitas Beban Kerja
• Identitas Terkelola
• Visual Studio
• Visual Studio Code
• Azure CLI (antarmuka baris perintah Azure)
• Azure PowerShell
• Azure Developer CLI

Jika plugin gagal mendapatkan token akses untuk mengakses Azure, plugin menunjukkan kesalahan dan Proksi Dev menonaktifkannya. Masuk ke Azure menggunakan salah satu alat ini, dan mulai ulang Dev Proxy untuk menggunakan plugin ApiCenterOnboardingPlugin.

Jika Anda menggunakan Dev Proxy di alur CI/CD, Anda dapat meneruskan nilai untuk properti subscriptionId, resourceGroupName, serviceName, dan workspace sebagai variabel lingkungan. Untuk menggunakan variabel lingkungan, tambahkan nama nilai dengan @, misalnya:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterOnboardingPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterOnboardingPlugin"
    }
  ],
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspace": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

Dalam contoh ini, plugin ApiCenterOnboardingPlugin menetapkan properti subscriptionId, resourceGroupName, serviceName, dan workspace ke nilai variabel lingkungan AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAME, dan AZURE_APIC_WORKSPACE_NAME .

Langkah selanjutnya

Cara menemukan API bayangan