Membuat versi API

Halaman ini memberikan prosedur konfigurasi dan deployment mendetail untuk mengubah nomor versi API Anda. Prosedur yang Anda gunakan bergantung pada apakah perubahan pada API Anda kompatibel dengan versi lama.

Untuk informasi dan praktik terbaik tambahan, lihat Pengelolaan siklus proses API.

Perubahan yang kompatibel dengan versi lama

Saat Anda membuat perubahan pada API yang kompatibel mundur dengan kode klien yang ada, sebagai praktik terbaik, naikkan angka versi minor API sebelum Anda men-deploy versi baru. Meskipun Cloud Endpoints hanya menjalankan satu versi minor API dalam satu waktu, grafik dan log di Endpoints > Services menampilkan nomor versi. Dengan menaikkan nomor versi minor sebelum Anda men-deploy, grafik dan log akan memberikan histori deployment Anda yang diberi label.

Untuk menaikkan nomor versi minor:

  1. Di openapi.yaml, tambahkan nomor versi minor di kolom info.version. Misalnya, jika versi saat ini adalah 1.1, tetapkan info.version ke 1.2:

    info:
  description: "A simple Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.2"
host: "echo-api.endpoints.example-project-12345.cloud.goog"

  2. Gunakan Google Cloud CLI untuk men-deploy konfigurasi API:

    gcloud endpoints services deploy openapi.yaml

  3. Deploy backend API menggunakan ID konfigurasi yang ditampilkan dari langkah sebelumnya. Untuk mengetahui detailnya, lihat Men-deploy backend API.

Perubahan yang tidak kompatibel dengan versi lama

Saat Anda membuat perubahan pada API yang merusak kode klien pelanggan Anda, sebagai praktik terbaik, naikkan angka versi utama API Anda. Endpoints dapat menjalankan lebih dari satu versi utama API secara bersamaan. Dengan menyediakan kedua versi API, pelanggan Anda dapat memilih versi yang ingin mereka gunakan dan mengontrol kapan mereka bermigrasi ke versi baru.

Untuk menjalankan versi API yang ada dan yang baru secara bersamaan:

  1. Buat file konfigurasi OpenAPI terpisah untuk setiap versi yang perlu Anda sajikan. Prosedur ini menggunakan nama file openapi-v1.yaml dan openapi-v2.yaml sebagai contoh.

  2. Salin konten openapi-v1.yaml ke openapi-v2.yaml.

  3. Di openapi-v1.yaml, konfigurasi hal berikut:

    • Tetapkan kolom info.version ke nomor versi yang ada.
    • Jangan ubah kolom basePath.

    Contoh:

    info:
  description: "A simple Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.1"
host: "echo-api.endpoints.example-project-12345.cloud.goog"
basePath: "/v1"

  4. Di openapi-v2.yaml, konfigurasi hal berikut:

    • Membuat perubahan yang tidak kompatibel dengan versi lama.
    • Tetapkan kolom info.version ke nomor versi baru.
    • Tetapkan kolom basePath untuk menyertakan nomor versi utama baru.
    • Hapus bagian x-google-endpoints. Bagian ini diperlukan jika Anda ingin menentukan alamat IP DNS atau flag allowCors. Saat men-deploy dua versi API dengan dua file konfigurasi YAML, hanya salah satunya yang dapat memiliki x-google-endpoints, tetapi konfigurasinya akan berlaku untuk kedua versi.

    Contoh:

    info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "2.0"
host: "echo-api.endpoints.example-project-12345.cloud.goog"
basePath: "/v2"

  5. Gunakan Google Cloud CLI untuk men-deploy kedua file konfigurasi API:

    gcloud endpoints services deploy openapi-v1.yaml openapi-v2.yaml

  6. Deploy satu backend yang melayani kedua versi API dengan menggunakan ID konfigurasi yang ditampilkan dari langkah sebelumnya. Untuk mengetahui detailnya, lihat Men-deploy backend API.

Langkah berikutnya