Bagikan melalui


Tutorial: Mempublikasikan beberapa versi API Anda

BERLAKU UNTUK: Semua tingkatAN API Management

Ada kalanya akan tidak praktis meminta semua pemanggil ke API Anda menggunakan versi yang sama persis. Ketika pemanggil ingin memutakhirkan ke versi yang lebih baru, mereka menginginkan pendekatan yang mudah dipahami. Seperti yang telah ditunjukkan dalam tutorial ini, dimungkinkan untuk menyediakan beberapa versi di Azure API Management.

Untuk latar belakang, lihat Versi & Revisi.

Dalam tutorial ini, Anda akan mempelajari cara:

  • Menambahkan versi baru ke API yang sudah ada
  • Pilih skema versi
  • Menambahkan versi ke produk
  • Menelusuri portal pengembang untuk melihat versi

Versi diperlihatkan di portal Microsoft Azure

Prasyarat

Menambahkan versi baru

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
  2. Pilih API.
  3. Pilih Demo Conference API dari daftar API Anda.
  4. Pilih menu pintasan (...) di samping Demo Conference API.
  5. Pilih Tambahkan versi.

Menu pintasan API - tambahkan versi

Tip

Versi juga dapat diaktifkan saat Anda membuat API baru. Pada layar Tambahkan API, pilih Versikan API ini?.

Pilih skema penerapan versi

Di Azure API Management, Anda memilih cara pemanggil menentukan versi API dengan memilih skema penerapan versi: path, header, atau string kueri. Dalam contoh berikut, jalur digunakan sebagai skema penerapan versi.

Masukkan nilai dari tabel berikut ini. Lalu pilih Buat untuk membuat versi Anda.

Tambahkan jendela versi

Pengaturan Nilai Deskripsi
Nama demo-conference-api-v1 Nama unik di API Management Anda.

Karena versi sebenarnya adalah API baru berdasarkan revisi API, pengaturan ini adalah nama API baru.
Skema penerapan versi Jalur Cara pemanggil menentukan versi API.
Pengidentifikasi versi v1 Indikator khusus skema versi. Untuk Jalur, akhiran untuk jalur URL API.

Jika string Header atau Kueri dipilih, masukkan nilai tambahan: nama parameter string header atau kueri.

Contoh penggunaan ditampilkan.
Produk Tidak Terbatas Secara opsional, satu atau beberapa produk yang dikaitkan dengan versi API. Untuk memublikasikan API, Anda harus mengaitkannya dengan produk. Anda juga dapat menambahkan versi ke produk nanti.

Setelah membuat versi, sekarang muncul di bawah Demo Conference API di Daftar API. Anda sekarang melihat dua API: Asli, dan v1.

Versi yang tercantum di bawah API di portal Microsoft Azure

Catatan

Jika Anda menambahkan versi ke API non-versi, yang Asli juga akan dibuat secara otomatis. Versi ini merespons URL default. Membuat versi Asli memastikan bahwa pemanggil yang ada tidak rusak oleh proses penambahan versi. Jika Anda membuat API baru dengan versi yang diaktifkan di awal, maka yang Asli tidak dibuat.

Mengedit versi

Setelah menambahkan versi, Anda sekarang dapat mengedit dan mengonfigurasikannya sebagai API yang terpisah dari yang Asli. Perubahan pada satu versi tidak mempengaruhi versi lain. Misalnya, tambahkan atau hapus operasi API, atau edit spesifikasi OpenAPI. Untuk informasi selengkapnya, lihat Edit API.

Menambahkan versi ke produk

Agar pemanggil dapat melihat versi baru, pemanggil harus ditambahkan ke produk. Jika Anda belum menambahkan versi ke produk, Anda dapat menambahkannya ke produk kapan saja.

Misalnya, untuk menambahkan versi ke produk Tak terbatas:

  1. Di portal Microsoft Azure, navigasikan ke instans API Management Anda.
  2. Pilih Produk>API Tanpa>Batas>+ Tambahkan.
  3. Pilih Demo Conference API, versi v1.
  4. Klik Pilih.

Menambahkan versi ke produk

Menggunakan kumpulan versi

Saat Anda membuat beberapa versi, portal Microsoft Azure akan membuat kumpulan versi, yang mewakili serangkaian versi untuk satu API logis. Memilih nama API yang memiliki beberapa versi. Portal Microsoft Azure menampilkan kumpulan Versinya. Anda dapat menyesuaikan Nama dan Deskripsi dari set virtual.

Anda dapat berinteraksi langsung dengan kumpulan versi dengan menggunakan Azure CLI:

Untuk melihat semua set versi Anda, jalankan perintah daftar versionset az apim api:

az apim api versionset list --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --output table

Saat portal Microsoft Azure membuat set versi untuk Anda, portal Azure menetapkan nama alfanumerik, yang muncul di daftar kolom Nama. Gunakan nama ini di perintah Azure CLI lainnya.

Untuk melihat detail tentang set versi, jalankan perintah tampilkan versionset az apim api:

az apim api versionset show --resource-group apim-hello-world-resource-group \
    --service-name apim-hello-world --version-set-id 00000000000000000000000

Untuk informasi selengkapnya tentang set versi, lihat Versi di Azure API Management.

Menelusuri portal pengembang untuk melihat versi

Jika Anda sudah mencoba portal pengembang, Anda dapat melihat versi API di sana.

  1. Pilih Portal Pengembang dari menu atas.
  2. Pilih API,lalu pilih Demo Conference API.
  3. Anda akan melihat dropdown dengan beberapa versi di samping nama API.
  4. Pilih v1.
  5. Perhatikan URL Permintaan dari operasi pertama dalam daftar. Ini menunjukkan bahwa jalur URL API termasuk v1.

Langkah berikutnya

Dalam tutorial ini, Anda mempelajari cara:

  • Menambahkan versi baru ke API yang sudah ada
  • Pilih skema versi
  • Menambahkan versi ke produk
  • Menelusuri portal pengembang untuk melihat versi

Melanjutkan ke tutorial berikutnya: