Bagikan melalui


Mengimpor spesifikasi OpenAPI

BERLAKU UNTUK: Semua tingkatAN API Management

Artikel ini menunjukkan cara mengimpor API backend "Spesifikasi OpenAPI" ke Azure API Management menggunakan berbagai alat. Artikel ini juga menampilkan cara menguji API di API Management.

Dalam artikel ini, Anda akan mempelajari cara:

  • Mengimpor spesifikasi OpenAPI menggunakan portal Azure, Azure CLI, atau Azure PowerShell
  • Menguji API di portal Microsoft Azure

Catatan

Batasan impor API didokumentasikan dalam pembatasan impor API dan masalah yang diketahui.

Prasyarat

Mengimpor API backend

Untuk contoh ini, Anda mengimpor spesifikasi OpenAPI untuk SUMBER TERBUKA Petstore API, tetapi Anda dapat mengganti spesifikasi OpenAPI pilihan Anda.

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Di menu sebelah kiri, pilih API>+ Tambahkan API.

  3. Di bagian Buat dari definisi, pilih OpenAPI.

    Cuplikan layar pembuatan API dari spesifikasi OpenAPI di portal.

  4. Masukkan pengaturan API. Anda dapat mengatur nilai selama pembuatan atau mengkonfigurasinya nanti dengan masuk ke tab Pengaturan. Pengaturan dijelaskan dalam tutorial Mengimpor dan menerbitkan API pertama Anda.

  5. Pilih Buat.

Menampilkan dan mengedit spesifikasi OpenAPI

Di portal, gunakan editor spesifikasi OpenAPI untuk melihat, memvalidasi, atau mengedit spesifikasi untuk API yang Anda impor.

Untuk menggunakan editor spesifikasi OpenAPI:

  1. Di portal Microsoft Azure, navigasikan ke instans API Management Anda.
  2. Di menu sebelah kiri, di bawah API, pilih API><Anda>>Semua operasi.
  3. Pada tab Desain , di Frontend, pilih editor Spesifikasi OpenAPI (ikon pensil). Anda dapat membuka spesifikasi dalam format JSON atau YAML.
  4. Tinjau atau edit spesifikasi sesuai kebutuhan. Simpan perubahan Anda.

Memvalidasi terhadap skema spesifikasi OpenAPI

Anda dapat mengonfigurasi kebijakan validasi API Management untuk memvalidasi permintaan dan respons (atau elemennya) terhadap skema dalam spesifikasi OpenAPI. Misalnya, gunakan kebijakan validasi konten untuk memvalidasi ukuran atau konten isi permintaan atau respons.

Menguji API baru di portal

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

  1. Memilih API yang Anda buat di langkah sebelumnya.

  2. Pilih tab Uji.

  3. 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.

  4. 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.

Menambahkan API lainnya

Anda dapat membuat API dari API yang diekspos oleh berbagai layanan, termasuk:

  • Spesifikasi OpenAPI
  • API SOAP
  • A GraphQL API
  • Aplikasi Web yang dihosting di Azure App Service
  • Azure Function App
  • Azure Logic Apps
  • Azure Service Fabric

Tambahkan API yang berbeda ke API yang ada menggunakan langkah-langkah berikut.

Catatan

Saat mengimpor API lain, operasi ditambahkan ke API Anda saat ini.

  1. Buka instans API Management Azure Anda di portal Microsoft Azure.

    Cuplikan layar menavigasi ke instans API Management di portal.

  2. Pilih API pada halaman Ringkasan atau dari menu di sebelah kiri.

    Cuplikan layar memilih API di halaman Gambaran Umum di portal.

  3. Klik ... di samping API tempat Anda ingin menambahkan API lain.

  4. Pilih Impor dari menu turun.

    Pilih impor

  5. Pilih layanan untuk mengimpor API.

    Cuplikan layar memilih layanan di portal.

Langkah berikutnya