Halaman ini diterjemahkan oleh Cloud Translation API.

Mengelola versi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Topik ini menjelaskan cara membuat dan mengelola versi API. Untuk mempelajari versi, lihat Ringkasan versi.

Menambahkan versi ke API

Anda dapat menambahkan versi API ke API yang ada di konsol atau dengan REST API.

Konsol

Untuk menambahkan versi baru:

Di konsol Google Cloud, buka halaman API hub.
Buka hub API
Klik API.
Temukan API yang ingin Anda buat versinya. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Klik API untuk melihat detailnya.
Di tab Versi, klik Tambahkan Versi.
Tentukan detail versi di formulir Tambahkan versi baru. Anda harus memberikan nama tampilan. Atribut lainnya bersifat opsional. Untuk mengetahui informasi selengkapnya tentang atribut, lihat Mengelola atribut.
- Nama: (Wajib) Anda harus memberikan nama tampilan.
- Deskripsi: Tambahkan deskripsi versi.
- Siklus Proses: Pilih tahap siklus proses API.
- Kepatuhan: Pilih atribut kepatuhan.
- Akreditasi: Pilih atribut akreditasi.
- Dokumentasi: Masukkan URL ke dokumentasi untuk API.
- Tambahkan file Spesifikasi: Impor file spesifikasi API untuk dikaitkan dengan versi. Lihat Menambahkan spesifikasi API ke versi.
- Tautkan ke deployment: Pilih satu atau beberapa deployment untuk dikaitkan dengan API.
- Atribut yang ditentukan pengguna: Atribut yang ditentukan pengguna adalah atribut yang Anda tentukan berdasarkan kebutuhan organisasi atau tim. Lihat Atribut pengguna.
Klik Create.

REST

Untuk menambahkan versi baru menggunakan API Create an API version:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions?version_id=VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": "DISPLAY_NAME",
    "description": "DESCRIPTION"               # description is an optional attribute
    }'

Ganti kode berikut:

HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
API_ID: ID unik resource API tempat versi akan ditambahkan.
VERSION_ID: (Opsional) ID unik versi API. Jika tidak disediakan, ID yang dihasilkan sistem akan digunakan. Nama harus berupa string 4-63 karakter, dengan karakter yang valid adalah /[a-z][0-9]-/.
DISPLAY_NAME: (Wajib) Nama tampilan versi. Anda dapat menggunakan nama apa pun yang Anda inginkan.
DESCRIPTION: (Opsional) Anda dapat menambahkan sejumlah atribut opsional untuk mendeskripsikan versi, termasuk deskripsi, nama pemilik, link ke dokumentasi, dan lainnya. Atribut opsional ini tercantum dan dijelaskan dalam Definisi resource versi.

Contoh output:

{
  "name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
  "displayName": "My Version 1",
  "createTime": "2024-04-02T18:48:41.162360Z",
  "updateTime": "2024-04-02T18:48:41.162360Z"
}

Mencantumkan versi API

Bagian ini menjelaskan cara mencantumkan versi yang terkait dengan API terdaftar.

Konsol

Untuk melihat semua versi yang terkait dengan API terdaftar di konsol:

Di konsol Google Cloud, buka halaman API hub.
Buka hub API
Klik API.
Temukan API yang ingin Anda periksa. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Pilih API.
Versi tercantum dalam tabel Versi di halaman detail API.

REST

Untuk melihat semua versi yang terkait dengan API terdaftar, gunakan API List API versions:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Ganti kode berikut:

HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
API_ID: ID unik resource API.

Contoh output:

{
  "versions": [
    {
      "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
      "displayName": "Streetcarts Test v1"
    }
  ]
}

Mendapatkan detail versi API

Bagian ini menjelaskan cara mendapatkan detail tentang versi API, termasuk atribut, operasi, deployment, dan file spesifikasinya.

Konsol

Untuk melihat detail versi di konsol:

Di konsol Google Cloud, buka halaman API hub.
Buka hub API
Klik API.
Temukan API yang ingin Anda periksa. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Pilih API.
Di tabel Versions, klik versi untuk melihat halaman detail versi.

REST

Untuk melihat detail versi menggunakan API Get API version details:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Ganti kode berikut:

HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
API_ID: ID unik resource API.
VERSION_ID: ID unik versi.

Contoh output:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1",
  "displayName": "Test Version 3",
  "documentation": {},
  "specs": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/specs/docs-spec-1"
  ],
  "apiOperations": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/listpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/createpets",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/deletepet",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/getpetbyid",
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/updatepet"
  ],
  "definitions": [
    "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/definitions/pet"
  ],
  "createTime": "2024-04-04T14:53:57.299213423Z",
  "updateTime": "2024-04-04T14:53:58.027321138Z"
}

Menghapus versi API

Bagian ini menjelaskan cara menghapus versi API yang terkait dengan resource API.

Konsol

Saat Anda menghapus versi di UI, semua spesifikasi dasar yang terkait dengan versi tersebut (jika ada) akan dihapus.

Untuk menghapus versi:

Di konsol Google Cloud, buka halaman API hub.
Buka hub API
Klik API.
Cari API yang menyertakan versi yang ingin Anda hapus. Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Pilih API.
Di tabel Versi, temukan versi yang ingin dihapus.
Dari menu Actions (sisi kanan baris yang berisi versi), klik Delete.

REST

Secara default, versi hanya dapat dihapus jika semua spesifikasi yang mendasarinya dihapus. Jika Anda ingin menghapus semua spesifikasi dalam versi dalam satu langkah, tetapkan parameter kueri force ke true di Delete REST API.

Untuk menghapus versi menggunakan API Delete API version:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID'

Ganti kode berikut:

API_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
API_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
API_ID: ID unik resource API.
VERSION_ID: ID versi yang akan dihapus.

Untuk menghapus versi dan semua spesifikasi yang mendasarinya, tetapkan parameter kueri force ke true. Contoh:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID?force=true'

Mengedit versi

Konsol

Untuk mengedit versi:

Di konsol Google Cloud, buka halaman API hub.
Buka hub API
Klik API.
Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Pilih API.
Di tabel Versi, temukan versi yang ingin Anda edit.
Pilih Edit dari menu Tindakan di sisi kanan baris versi. Anda juga dapat mengakses fitur edit dengan mengklik Edit Versi di halaman detail versi. Untuk membuka halaman detail, cukup klik versi di tabel versi.
Setelah melakukan pengeditan, klik Simpan untuk menyimpan perubahan. Untuk deskripsi atribut yang dapat diedit, lihat deskripsi resource versi dalam referensi REST API.

REST

Untuk mengedit versi dengan REST API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
    '{
      "display-name": DISPLAY_NAME,  # Use the request body to specify attribute changes
      "description": "DESCRIPTION"

    }'

Ganti kode berikut:

HUB_PROJECT: Nama project host hub API Anda. Project host dipilih saat API hub disediakan.
HUB_LOCATION: Lokasi project host. Lokasi dipilih saat hub API disediakan.
API_ID: ID unik API yang memiliki versi yang ingin Anda edit.
VERSION_ID: ID versi yang akan diedit.
DESCRIPTION: Anda dapat menambahkan atribut lain yang dapat diedit dalam isi permintaan, seperti deskripsi dan lainnya. Atribut yang dapat diedit tercantum dalam referensi API hub Apigee. Patch version API.
LIST_OF_ATTRIBUTES: Daftar nama atribut yang sepenuhnya memenuhi syarat dan dipisahkan koma. Contoh: ?updateMask="description".

Contoh output:

{
  "name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
  "displayName": "Streetcarts Test v1",
  "description": "This is a revision of the test version.",
  "documentation": {},
  "createTime": "2024-04-18T19:57:11.870761Z",
  "updateTime": "2024-04-18T20:23:42.465324Z"
}