Impor API SOAP ke API Management

Artikel
02/02/2024

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini menjelaskan cara mengimpor spesifikasi WSDL, yang merupakan representasi XML standar API SOAP. Artikel ini juga menampilkan cara menguji API di API Management.

Dalam artikel ini, Anda akan mempelajari cara:

Mengimpor API SOAP
Menguji API di portal Microsoft Azure

Catatan

Impor WSDL ke API Management diatur dalam batasan tertentu. File WSDL dengan arahan wsdl:import, xsd:import, dan xsd:include tidak didukung. Terkait alat sumber terbuka untuk memperbaiki dan menggabungkan dependensi ini dalam file WSDL, lihat repositori GitHub ini.

Prasyarat

Sebuah instans API Management. Jika Anda belum memilikinya, selesaikan mulai cepat berikut: Membuat instans Azure API Management.
Azure CLI
- Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.
- Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.
  - Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.
  - Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.
  - Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.
Azure PowerShell
- Jika Anda memilih untuk menggunakan Azure PowerShell secara lokal:
  - Instal versi terbaru modul Az PowerShell.
  - Sambungkan ke akun Azure Anda menggunakan cmdlet Connect-AzAccount.
- Jika Anda memilih untuk menggunakan Azure Cloud Shell:
  - Lihat Gambaran Umum Azure Cloud Shell untuk informasi selengkapnya.

Mengimpor API backend

Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
Di menu sebelah kiri, pilih API>+ Tambahkan API.
Di bawah Buat dari definisi, pilih WSDL.
Dalam spesifikasi WSDL, masukkan URL ke API SOAP Anda, atau klik Pilih file untuk memilih file WSDL lokal.
Dalam Metode impor, pass-through SOAP dipilih secara default. Dengan pilihan ini, API diekspos sebagai SOAP, dan konsumen API harus menggunakan aturan SOAP. Jika Anda ingin "memulihkan" API, ikuti langkah-langkah dalam Mengimpor SOAP API dan mengonversinya ke REST.
Pengaturan API berikut diisi secara otomatis berdasarkan informasi dari SOAP API: Nama tampilan, Nama, Deskripsi. Operasi diisi secara otomatis dengan Nama tampilan, URL, dan Deskripsi, dan menerima Nama yang dihasilkan sistem.
Masukkan pengaturan API lainnya. Anda dapat mengatur nilai selama pembuatan atau mengonfigurasikannya nanti dengan masuk ke tab Pengaturan.

Untuk informasi selengkapnya tentang pengaturan API, lihat tutorial Mengimpor dan menerbitkan API pertama Anda.
Pilih Buat.

Contoh berikut menggunakan perintah az apim api import untuk mengimpor spesifikasi WSDL dari URL yang ditentukan ke instans API Management bernama apim-hello-world. Untuk mengimpor menggunakan jalur ke spesifikasi, bukan URL, gunakan --specification-path parameter .

Untuk contoh WSDL ini, nama layanannya adalah OrdersAPI, dan salah satu titik akhir (antarmuka) yang tersedia adalah dasar.

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="order-api"
APIPath="order"
SpecificationFormat="Wsdl"
SpecificationURL="https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
WsdlServiceName="OrdersAPI"
WsdlEndpointName="basic"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL \
    --wsdl-service-name $WsdlServiceName --wsdl-endpoint-name $WsdlEndpointName

Contoh berikut menggunakan cmdlet Import-AzApiManagementApi Azure PowerShell untuk mengimpor spesifikasi WSDL dari URL yang ditentukan ke instans API Management bernama apim-hello-world. Untuk mengimpor menggunakan jalur ke spesifikasi, bukan URL, gunakan -SpecificationPath parameter .

Untuk contoh WSDL ini, nama layanannya adalah OrdersAPI, dan salah satu titik akhir (antarmuka) yang tersedia adalah dasar.

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific det
$apiId = "orders-api"
$apiPath = "orders"
$specificationFormat = "Wsdl"
$specificationUrl = "https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
$wsdlServiceName = "OrdersAPI"
$wsdlEndpointName = "basic"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath -WsdlServiceName $wsdlServiceName -WsdlEndpointName $wsdlEndpointName

Menguji API baru di portal

Operasi dapat dipanggil langsung dari portal, yang menyediakan cara mudah bagi administrator untuk melihat dan menguji operasi API.

Memilih API yang Anda buat di langkah sebelumnya.
Pilih tab Uji.
Pilih operasi. Halaman ini menampilkan bidang untuk parameter dan bidang kueri untuk header.

Catatan

Di konsol pengujian, API Management secara otomatis mengisi header Ocp-Apim-Subscription-Key, dan mengonfigurasi kunci langganan langganan semua akses bawaan. Kunci ini memungkinkan akses ke setiap API dalam instans API Management. Secara opsional tampilkan header Ocp-Apim-Subscription-Key dengan memilih ikon "mata" di samping Permintaan HTTP.
Bergantung pada operasi, masukkan nilai parameter kueri, nilai header, atau isi permintaan. Pilih Kirim.

Ketika pengujian berhasil, backend merespons dengan kode respons HTTP yang berhasil dan beberapa data.

Tip

Secara default, konsol pengujian mengirimkan permintaan ke proksi CORS API Management, yang meneruskan permintaan ke instans API Management, yang kemudian meneruskannya ke backend. Proksi ini menggunakan alamat IP publik 13.91.254.72 dan hanya dapat menjangkau titik akhir publik. Jika Anda ingin mengirim permintaan langsung dari browser ke layanan API Management, pilih Lewati proksi CORS. Gunakan opsi ini saat Anda ingin menggunakan konsol pengujian dan gateway API Management Anda terisolasi jaringan atau tidak mengizinkan lalu lintas dari proksi CORS.

Untuk men-debug API, lihat Tutorial: Men-debug API Anda menggunakan pelacakan permintaan.

Tindakan SOAP wildcard

Jika Anda perlu meluluskan permintaan SOAP yang tidak memiliki tindakan khusus yang ditentukan dalam API, Anda dapat mengonfigurasikan tindakan SOAP wildcard. Tindakan wildcard akan cocok dengan permintaan SOAP apa pun yang tidak ditentukan dalam API.

Untuk menentukan tindakan SOAP wildcard:

Dalam portal, memilih API yang Anda buat di langkah sebelumnya.
Di tab Desain, pilih + Tambahkan Operasi.
Masukkan Nama tampilan untuk operasi.
Di URL, pilih POST dan masukkan/soapAction={any} di sumber daya. Parameter templat di dalam kurung kurawal bersifat manasuka dan tidak memengaruhi eksekusi.