Halaman ini menjelaskan cara melakukan pembuatan versi untuk API Anda dan cara men-deploy ke beberapa versi.
Rekomendasi untuk mengelola versi API
Dalam mengelola versi API, pertimbangkan rekomendasi berikut:
- Jika Anda ingin memperkenalkan perubahan inkremental, tetapi tidak menyebabkan gangguan, pertahankan versi API tetap konstan dan deploy melalui API yang ada.
- Saat Anda memperkenalkan perubahan yang dapat menyebabkan gangguan pada API, naikkan versi API.
- Untuk perlindungan tambahan, naikkan versi aplikasi App Engine juga, lalu deploy versi API baru ke versi aplikasi App Engine baru tersebut. 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 berjenjang ke versi aplikasi App Engine yang berbeda.
| Versi aplikasi | Versi Backend API |
|---|---|
| 1 |
|
| 2 |
|
| 3 |
|
Seperti yang ditunjukkan dalam tabel, update inkremental yang tidak merusak pada API v1 diluncurkan, dan setiap update akan menggantikan versi sebelumnya. Saat perubahan yang dapat menyebabkan gangguan diperkenalkan, versi API akan di-upgrade ke v2 dan di-deploy ke versi aplikasi App Engine baru. Dengan begitu, Anda dapat beralih kembali ke versi aplikasi sebelumnya jika diperlukan.
Dalam tabel, perhatikan bahwa aplikasi versi 2 mendukung versi v1 terbaru
dan versi v2 baru API Anda. Jika Anda tidak menghapus kode v1 yang ada dari project, saat Anda men-deploy project, v2 dan vl (n) API Anda akan di-deploy ke versi 2 aplikasi Anda.
Men-deploy ke beberapa versi aplikasi
Saat men-deploy API backend, Anda men-deploy-nya ke project ID
Google Cloud project yang Anda buat untuk API, dan Anda juga harus
menentukan versi App Engine yang Anda deploy.
Anda menentukan versi aplikasi App Engine di command line saat
Anda
men-deploy aplikasi.
Versi aplikasi App Engine tidak sama dengan nomor versi
API backend, yang Anda tentukan dalam argumen version ke
decorator @endpoints.api.
Seperti yang ditunjukkan pada gambar sebelumnya, Anda dapat men-deploy beberapa versi API ke versi App Engine yang sama. Selain itu, Anda dapat memiliki banyak versi App Engine untuk satu aplikasi.
Mengakses versi API yang di-deploy ke versi penayangan
Versi App Engine pertama yang Anda deploy API-nya adalah versi penayangan. Versi ini berjalan di URL
http://YOUR_PROJECT_ID.appspot.com dengan
YOUR_PROJECT_ID mewakili ID project Google Cloud
Anda. Anda dapat mengakses semua versi API yang di-deploy ke versi aplikasi App Engine tersebut menggunakan URL tersebut.
Versi penayangan tetap sama hingga Anda mengubahnya secara eksplisit di Google Cloud konsol.
Mengakses versi API yang di-deploy ke versi aplikasi yang tidak ditayangkan
Jika Anda perlu mengakses versi API yang tidak di-deploy ke versi App Engine yang saat ini ditayangkan, Anda menggunakan URL khusus versi, mirip dengan 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, lihat dokumentasi App Engine.
Mengakses versi API yang di-deploy ke layanan non-penayangan (sebelumnya modul)
Jika 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, lihat dokumentasi App Engine.