Membuat API

Prasyarat

Sebelum dapat membuat API di Gateway API, pastikan Anda telah:

Persyaratan ID API

Banyak dari perintah gcloud yang ditampilkan di bawah ini mengharuskan Anda menentukan ID API, dalam bentuk: API_ID. Gateway API menerapkan persyaratan berikut untuk ID API:

  • Harus memiliki panjang maksimum 63 karakter.
  • Hanya boleh berisi huruf kecil, angka, atau tanda pisah.
  • Tidak boleh diawali dengan tanda hubung.
  • Tidak boleh berisi garis bawah.

Membuat API

Untuk membuat API:

  1. Validasi project ID yang ditampilkan dari perintah berikut untuk memastikan layanan tidak dibuat dalam project yang salah.

    gcloud config list project

    Jika Anda perlu mengubah project default, jalankan perintah berikut dan ganti PROJECT_ID dengan project ID Google Cloud yang ingin digunakan untuk membuat layanan:

    gcloud config set project PROJECT_ID

    Jika project ID Anda berisi titik dua (:), lihat Project cakupan domain untuk mengetahui detail tambahan tentang cara membuat API di project Anda.

  2. Lihat bantuan untuk perintah apis create:

    gcloud api-gateway apis create --help

  3. Jalankan perintah berikut untuk membuat API:

    gcloud api-gateway apis create API_ID --project=PROJECT_ID

    dengan:

    • API_ID menentukan ID API baru. Lihat persyaratan ID API untuk panduan penamaan API.
    • PROJECT_ID menentukan ID project Google Cloud.

    Saat membuat API, Gateway API menghasilkan informasi ke terminal.

  4. Setelah berhasil diselesaikan, Anda dapat menggunakan perintah berikut untuk melihat detail tentang API baru:

    gcloud api-gateway apis describe API_ID --project=PROJECT_ID

    Perintah ini akan menampilkan hal berikut:

    createTime: '2020-02-29T21:52:20.297426875Z'
displayName: API_ID
managedService: MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog
name: projects/PROJECT_ID/locations/global/apis/API_ID
state: ACTIVE
updateTime: '2020-02-29T21:52:20.647923711Z'

opsi gcloud

Google Cloud CLI menggunakan banyak opsi, termasuk yang dijelaskan dalam Referensi gcloud. Selain itu, untuk Gateway API, Anda dapat menetapkan opsi berikut saat membuat API:

  • --async: Segera mengembalikan kontrol ke terminal, tanpa menunggu operasi selesai.
  • --display-name=NAME: Menentukan nama tampilan API, artinya nama yang ditampilkan di UI. Jangan gunakan spasi dalam nama. Gunakan tanda hubung dan garis bawah sebagai gantinya. Nilai defaultnya adalah API_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,...: Menentukan label yang terkait dengan konfigurasi API.
  • --managed-service: Menentukan layanan terkelola yang sudah ada sebelumnya (misalnya, layanan Endpoint yang ada) untuk API.

Project cakupan domain

Jika project Anda dicakupkan ke domain, project ID akan menyertakan nama domain yang diikuti dengan titik dua (:), misalnya, example.com:my-project. Anda harus menyediakan layanan terkelola yang valid saat membuat API dalam project cakupan domain.

Jika menggunakan gcloud, berikan nama layanan terkelola menggunakan flag --managed-service, seperti yang dijelaskan dalam opsi gcloud.

API Listingan

Untuk menampilkan daftar semua API dalam sebuah project: 

gcloud api-gateway apis list --project=PROJECT_ID

Perintah ini menampilkan output dalam bentuk:

NAME                                              DISPLAY_NAME  MANAGED_SERVICE                          STATE
projects/PROJECT_ID/locations/global/apis/API_ID  API_ID        MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog  ACTIVE

Gunakan project ID dan API ID untuk mendapatkan informasi mendetail tentang API:

gcloud api-gateway apis describe API_ID --project=PROJECT_ID

Mengupdate API

Setelah pembuatan, Anda dapat memperbarui label dan nama tampilan dari API yang sudah ada. Gunakan opsi gcloud berikut untuk mengupdate API yang sudah ada:

  • --display-name
  • --update-labels
  • --clear-labels
  • --remove-labels

Contoh:

gcloud api-gateway apis update API_ID --project=PROJECT_ID \
  --update-labels=a=1,b=2

Gunakan perintah berikut untuk melihat semua opsi update:

gcloud api-gateway apis update --help

Menghapus API

Untuk menghapus API, Anda harus:

  • Menghapus konfigurasi API yang terkait dengan API.
  • Menghapus API.

Cara menghapus API:

  1. Tentukan daftar konfigurasi API yang terkait dengan API:

    gcloud api-gateway api-configs list --api=API_ID --project=PROJECT_ID

  2. Hapus setiap konfigurasi API yang terkait dengan API:

    gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID --project=PROJECT_ID

  3. Hapus API:

    gcloud api-gateway apis delete API_ID --project=PROJECT_ID

Langkah selanjutnya