Revisi di Azure API Management

BERLAKU UNTUK: Semua tingkatan Manajemen API

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

Nota

Portal pengembang tidak tersedia di tingkat layanan Konsumsi.

Dengan revisi, Anda dapat:

• Buat perubahan dengan aman pada definisi dan kebijakan API Anda, tanpa mengganggu API produksi Anda.
• Cobalah perubahan sebelum menerbitkannya.
• Dokumentasikan perubahan yang Anda buat, sehingga pengembang Anda dapat memahami apa yang baru.
• Gulung balik jika Anda menemukan masalah.

Mulailah dengan 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 customers API:

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 memiliki keamanan berbeda yang diterapkan untuk setiap revisi. Misalnya, Anda mungkin ingin menambahkan kebijakan pemfilteran IP untuk mencegah penelepon eksternal mengakses revisi yang masih dalam pengembangan.

Nota

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

Revisi saat ini

Satu revisi dapat ditetapkan sebagai revisi saat ini . Revisi ini adalah yang digunakan untuk semua permintaan API yang tidak menentukan nomor revisi eksplisit di URL. Anda dapat mengembalikan 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 New-AzApiManagementApiRelease cmdlet .

Deskripsi revisi

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

Saat Anda mengatur revisi sebagai saat ini, Anda juga dapat secara opsional menentukan catatan log perubahan publik. Log perubahan disertakan dalam portal pengembang untuk dilihat pengguna API Anda. Anda dapat mengubah catatan log perubahan menggunakan Update-AzApiManagementApiRelease cmdlet 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 ini dalam revisi non-saat ini, pesan Can't change property for non-current revision kesalahan akan ditampilkan.

Membawa revisi ke mode offline

Revisi dapat diambil 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.

Nota

Sebaiknya ambil 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 nonversi. Anda dapat menggunakan revisi tanpa menggunakan versi, atau sebaliknya. Biasanya versi digunakan untuk memisahkan versi API dengan perubahan signifikan, sementara revisi dapat digunakan untuk perubahan kecil yang tidak signifikan pada API.

Jika revisi Anda memiliki perubahan yang signifikan, atau jika Anda ingin mengubah revisi secara resmi menjadi versi beta atau versi uji, Anda dapat membuat versi dari revisi. Menggunakan portal Microsoft Azure, pilih 'Buat Versi dari Revisi' pada menu konteks revisi pada tab Revisi.