Halaman ini menjelaskan cara melakukan pembuatan versi untuk API dan cara men-deploy-nya ke beberapa versi.
Rekomendasi untuk mengelola versi API
Dalam mengelola versi API Anda, pertimbangkan rekomendasi berikut:
- Jika Anda ingin memperkenalkan perubahan inkremental, tetapi tidak menyebabkan gangguan, pertahankan versi API tetap konstan dan deploy melalui API yang sudah ada.
- Saat Anda memperkenalkan perubahan yang dapat menyebabkan gangguan pada API, tambahkan versi API.
- Untuk perlindungan tambahan, tambahkan juga versi aplikasi App Engine, lalu deploy versi API baru ke versi aplikasi App Engine yang baru. Hal ini memungkinkan Anda menggunakan fleksibilitas bawaan App Engine untuk beralih dengan cepat antara versi App Engine dan menayangkan dari versi lama yang berfungsi jika Anda mengalami masalah yang tidak terduga.
Tabel berikut adalah ilustrasi versi API backend bertingkat untuk berbagai versi aplikasi App Engine.
| Versi aplikasi | Versi API Backend |
|---|---|
| 1 |
|
| 2 |
|
| 3 |
|
Seperti yang ditunjukkan dalam tabel, update inkremental yang tidak menyebabkan gangguan pada API v1 diluncurkan, masing-masing menimpa versi sebelumnya. Saat perubahan yang dapat menyebabkan gangguan diperkenalkan, versi API bertambah ke v2 dan di-deploy ke versi aplikasi App Engine baru. Hal ini memungkinkan Anda untuk beralih kembali ke versi aplikasi sebelumnya jika diperlukan.
Dalam tabel, perhatikan bahwa aplikasi versi 2 mendukung API versi v1 terbaru
dan versi v2 yang baru dari API Anda. Jika Anda tidak menghapus kode v1 yang sudah ada dari project, v2 dan vl (n) API Anda akan di-deploy ke versi 2 aplikasi saat Anda men-deploy project.
Men-deploy ke beberapa versi aplikasi
Saat men-deploy API backend, Anda men-deploy-nya ke project ID
dari project Google Cloud yang Anda buat untuk API, dan Anda juga harus
menentukan versi App Engine yang akan di-deploy.
Anda menentukan versi aplikasi App Engine di elemen <version> file /WEB-INF/appengine-web.xml. Versi aplikasi App Engine tidak sama dengan nomor versi API backend, yang Anda tentukan dalam atribut version anotasi @Api.
Seperti ditunjukkan dalam gambar sebelumnya, Anda dapat men-deploy beberapa versi API ke versi App Engine yang sama. Anda juga dapat memiliki banyak versi App Engine untuk sebuah aplikasi.
Mengakses versi API yang di-deploy ke versi penayangan
Versi App Engine pertama tempat Anda men-deploy API adalah versi penayangan. Versi ini berjalan di URL
http://YOUR_PROJECT_ID.appspot.com, dengan
YOUR_PROJECT_ID mewakili project ID
Google Cloud Anda. Anda dapat mengakses semua versi API yang di-deploy ke versi aplikasi App Engine tersebut dengan menggunakan URL tersebut.
Versi penayangan akan tetap sama sampai Anda mengubahnya secara eksplisit, di konsol Google Cloud.
Mengakses versi API yang di-deploy ke versi aplikasi yang tidak tayang
Jika Anda perlu mengakses versi API yang tidak di-deploy ke versi App Engine yang saat ini ditayangkan, gunakan URL khusus versi, seperti berikut ini:
https://VERSION-dot-YOUR_PROJECT_ID.appspot.com
Ganti VERSION dengan versi App Engine Anda, dan YOUR_PROJECT_ID dengan ID project Google Cloud Anda. Misalnya, anggaplah versi penayangan App Engine Anda adalah 1, tetapi Anda ingin mengakses versi API yang di-deploy ke versi 2. Anda akan
menggunakan URL ini: https://2-dot-YOUR_PROJECT_ID.appspot.com.
Untuk mengetahui detail selengkapnya, baca dokumentasi App Engine.
Mengakses versi API yang di-deploy ke layanan yang tidak tayang (sebelumnya modul)
Jika Anda perlu mengakses versi API yang tidak di-deploy ke layanan App Engine default, Anda dapat menggunakan URL khusus layanan menggunakan sintaksis titik sebagai berikut:
https://SERVICE-NAME-dot-YOUR_PROJECT_ID.appspot.com/_ah/api/...
Untuk mengetahui detail selengkapnya, baca dokumentasi App Engine.