Bagikan melalui

Revisi di Azure API Management

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

Revisi memungkinkan Anda membuat perubahan pada API dengan cara yang terkontrol dan aman. Saat Anda ingin membuat perubahan, buat revisi baru. Anda kemudian dapat mengedit dan menguji API tanpa mengganggu konsumen API Anda. Ketika Anda siap, Anda kemudian membuat arus revisi Anda. Pada saat yang sama, Anda dapat secara opsional memposting entri ke log perubahan, untuk menjaga konsumen API Anda tetap mengetahui apa yang telah berubah. Log perubahan diterbitkan ke portal pengembang Anda.

Catatan

Portal pengembang tidak tersedia di tingkat Konsumsi.

Dengan revisi Anda dapat:

  • Membuat perubahan dengan aman pada definisi dan kebijakan API Anda, tanpa mengganggu API produksi Anda.
  • Mencoba perubahan sebelum menerbitkannya.
  • Mendokumentasikan perubahan yang Anda buat, sehingga pengembang Anda bisa memahami apa yang baru.
  • Memutar balik jika Anda menemukan masalah.

Mulai menggunakan revisi dengan mengikuti panduan kami.

Mengakses revisi tertentu

Setiap revisi ke API Anda dapat diakses menggunakan URL yang dibentuk khusus. Tambahkan ;rev={revisionNumber} di akhir URL API Anda, tetapi sebelum string kueri, untuk mengakses revisi tertentu dari API tersebut. Misalnya, Anda dapat menggunakan URL ini untuk mengakses revisi 3 dari API customers:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

Secara default, setiap revisi memiliki pengaturan keamanan yang sama dengan revisi saat ini. Anda dapat dengan sengaja mengubah kebijakan untuk revisi tertentu jika Anda ingin keamanan yang berbeda diterapkan untuk setiap revisi. Misalnya, Anda mungkin ingin menambahkan kebijakan pemfilteran IP untuk mencegah pemanggil eksternal mengakses revisi yang masih dalam pengembangan.

Catatan

;rev={id} harus ditambahkan ke ID API, dan bukan jalur URI.

Revisi saat ini

Satu revisi dapat ditetapkan sebagai revisi saat ini. Revisi ini akan menjadi yang digunakan untuk semua permintaan API yang tidak menentukan nomor revisi eksplisit di URL. Anda dapat memutar balik ke revisi sebelumnya dengan mengatur revisi tersebut sebagai saat ini.

Anda dapat mengatur revisi sebagai saat ini menggunakan portal Microsoft Azure. Jika Anda menggunakan PowerShell, Anda dapat menggunakan cmdlet New-AzApiManagementApiRelease.

Deskripsi revisi

Saat membuat revisi, Anda dapat mengatur deskripsi untuk tujuan pelacakan Anda sendiri. Deskripsi tidak ditampilkan kepada pengguna API Anda.

Saat Anda menetapkan revisi sebagai saat ini, Anda juga dapat secara opsional menentukan catatan log perubahan publik. Log perubahan disertakan di portal pengembang untuk dilihat pengguna API Anda. Anda dapat mengubah catatan log perubahan menggunakan cmdlet Update-AzApiManagementApiRelease PowerShell.

Perhatian

Jika Anda mengedit revisi API yang tidak terkini, Anda tidak dapat mengubah properti berikut:

  • Nama
  • Tipe
  • Deskripsi
  • Langganan diperlukan
  • versi API
  • Deskripsi versi API
  • Jalur
  • Protokol

Properti ini hanya dapat diubah dalam revisi saat ini. Jika pengeditan Anda mengubah salah satu properti di atas dari revisi yang tidak terkini, pesan kesalahan Can't change property for non-current revision akan ditampilkan.

Menonaktifkan revisi

Revisi dapat dilakukan secara offline, yang membuatnya tidak dapat diakses oleh pemanggil bahkan jika mereka mencoba mengakses revisi melalui URL-nya. Anda dapat menandai revisi sebagai offline menggunakan portal Microsoft Azure.

Catatan

Sebaiknya lakukan revisi secara offline saat Anda tidak menggunakannya untuk pengujian.

Versi dan revisi

Versi dan revisi adalah fitur yang berbeda. Setiap versi dapat memiliki beberapa revisi, sama seperti API tak berversi. Anda dapat menggunakan revisi tanpa menggunakan versi, atau sebaliknya. Biasanya versi digunakan untuk memisahkan versi API dengan perubahan yang merusak (breaking change), sedangkan revisi dapat digunakan untuk perubahan kecil dan tidak merusak (non-breaking) pada API.

Jika Anda menemukan bahwa revisi Anda memiliki perubahan yang merusak (breaking change), atau jika Anda ingin mengubah revisi secara formal menjadi versi beta/tes, Anda dapat membuat versi dari revisi. Menggunakan portal Microsoft Azure, klik 'Buat Versi dari Revisi' pada menu konteks revisi pada tab Revisi.