Halaman ini diterjemahkan oleh Cloud Translation API.

Mengelola resource API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Mendaftarkan API

Saat mendaftarkan API ke API Hub, Anda membuat dan menyimpan entitas yang mewakili API. Kami menyebut entitas ini sebagai resource API. Resource API yang disimpan di API Hub dapat ditelusuri dan memberikan informasi operasional dan deskriptif yang mendetail tentang API. Pada saat mendaftarkan API atau setelahnya, Anda dapat menambahkan dan mengedit atribut resource API untuk membuat deskripsi lengkap API.

Konsol

Untuk mendaftarkan API:

Di konsol Google Cloud, buka halaman APIs di API hub.
Buka hub API
Klik Register API.
Di bagian Detail umum, secara opsional tentukan ID unik untuk API. Jika Anda tidak memberikan ID, sistem akan membuatkan ID untuk Anda. Jika Anda ingin memasukkan ID, klik Tetapkan ID Unik.

ID harus terdiri dari 4-500 karakter, dan karakter yang valid adalah /[A-Z][a-z][0-9]-/. ID adalah komponen terakhir dari nama resource API unik yang sepenuhnya memenuhi syarat, yang dalam format: projects/PROJECT/locations/LOCATION/apis/API_ID
(Wajib) Berikan nama tampilan untuk resource API.
Secara opsional, tambahkan atribut tambahan yang menjelaskan API. Anda dapat kembali ke API kapan saja untuk menambahkan atau mengubah atribut API. Lihat Mengedit resource API.
- Informasi pemilik: (Opsional) Nama dan alamat email pemilik API.
- Detail tambahan: (Opsional) Tentukan atribut untuk membantu menentukan API Anda dan membuatnya lebih mudah ditelusuri. Anda dapat menentukan nilai default untuk beberapa atribut ini di Setelan. Untuk mengetahui detailnya, lihat Mengelola atribut.
- Atribut yang ditentukan pengguna: (Opsional) Ini adalah atribut yang Anda tentukan di Setelan. Untuk mengetahui detailnya, lihat Mengelola atribut.
Klik Daftar.

REST

Untuk mendaftarkan API, gunakan REST API Create API.

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

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: (Opsional) Masukkan ID unik untuk API. Jika Anda tidak memberikan parameter kueri ini, sistem akan membuat ID unik untuk Anda. ID harus terdiri dari 4-500 karakter, dan karakter yang valid adalah /[A-Z][a-z][0-9]-/. ID adalah komponen terakhir dari nama resource API yang sepenuhnya memenuhi syarat dan unik, yang dalam format: projects/PROJECT/locations/LOCATION/apis/API_ID
DISPLAY_NAME: (Wajib) Nama tampilan resource API. Anda dapat menggunakan nama apa pun yang Anda inginkan.
DESCRIPTION: (Opsional) Anda dapat menambahkan sejumlah atribut opsional untuk mendeskripsikan resource API, termasuk deskripsi, pemilik, link ke dokumentasi API, dan lainnya. Atribut opsional ini tercantum dan dijelaskan dalam definisi resource API.

Mencantumkan resource API

Bagian ini menjelaskan cara mencantumkan resource API di API Hub. Dengan menambahkan filter, Anda dapat membatasi API yang ditampilkan dalam respons.

Konsol

Untuk mencantumkan resource API:

Di konsol Google Cloud, buka halaman APIs di API hub.
Buka hub API
Daftar semua API yang ditambahkan ke API Hub tercantum di halaman beranda API.
Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.

REST

Untuk mencantumkan semua resource API di project API Hub, gunakan API List APIs:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis"
  -X GET -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 API hub disediakan.

Contoh output:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-2",
      "displayName": "TestApi2",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-1",
      "displayName": "TestApi1",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo9013cfev",
      "displayName": "sample",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo90121",
      "displayName": "sample",
      "documentation": {}
    },
    ...
    ],
    "nextPageToken": "f4f4d78b-a974-46db-a214-dc139f8e9c8a"
  }

Contoh REST dengan filter

Anda dapat memfilter hasil daftar menggunakan API. Dalam contoh ini, kita memfilter API berdasarkan atribut yang ditentukan sistem:

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis' \
  -d filter="owner.email=\"testowner3@gmail.com\"" -d page_size=10

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 API hub disediakan.

Contoh output, yang difilter menurut pemilik:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/theme-park-management-api",
      "displayName": "Theme Park Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/restaurant-api",
      "displayName": "Restaurant API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/casino-management-api",
      "displayName": "Casino Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/hotel-boooking-api",
      "displayName": "Hotel Booking API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api3",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api2",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api1",
      "displayName": "Test Pets API",
      "documentation": {}
    }
  ]
}

Mendapatkan detail resource API

Bagian ini menjelaskan cara mendapatkan detail tentang resource API.

Konsol

Untuk melihat detail resource API:

Di konsol Google Cloud, buka halaman APIs di API hub.
Buka hub API
Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API.
Klik API untuk melihat halaman detailnya.

REST

Untuk melihat detail resource API, gunakan API Get API resource details:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_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.

Contoh output:

{
  "name": "projects/myproject/locations/us-central1/apis/myapi",
  "displayName": "My Test API",
  "description": "This is a test API.",
  "documentation": {},
  "owner": {
    "displayName": "Test API,
    "email": "testowner@gmail.com"
  },
  "versions": [
    "projects/myproject/locations/us-central1/apis/myapi/versions/myapi-version1"
  ],
  "createTime": "2024-03-26T10:13:15.668867002Z",
  "updateTime": "2024-03-26T10:13:16.700716401Z"
}

Menghapus resource API

Bagian ini menjelaskan cara menghapus resource API.

Konsol

Jika Anda menghapus API di UI, semua versi API yang mendasarinya dan spesifikasi API terkait (jika ada) akan dihapus.

Untuk menghapus resource API:

Di konsol Google Cloud, buka halaman APIs di API hub.
Buka hub API
Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API yang akan dihapus.
Dari menu Actions (sisi kanan baris yang berisi API), klik Delete.

REST

Untuk menghapus API dari API Hub, gunakan API Delete API.

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

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

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 API hub disediakan.
API_ID: ID unik resource API yang akan dihapus.

Untuk menghapus API dan semua versi 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/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID?force=true'

Mengedit resource API

Bagian ini menjelaskan cara mengedit resource API. Tidak semua atribut resource API dapat diedit. Untuk daftar atribut yang dapat diedit, lihat dokumen referensi Patch API.

Konsol

Untuk mengedit API:

Di konsol Google Cloud, buka halaman APIs di API hub.
Buka hub API
Gunakan Filter untuk menentukan kata kunci guna memfilter daftar API. Jika perlu, gunakan Telusuri untuk menemukan API yang akan diedit.
Klik API untuk melihat halaman detailnya.
Klik Edit API.
Di halaman Edit API, buat perubahan Anda. Klik Lanjutkan untuk berpindah ke kumpulan atribut yang dapat diedit berikutnya.
- Detail umum: Anda dapat mengedit nama tampilan API.
- Informasi pemilik: Nama dan alamat email pemilik API.
- Detail tambahan: Ini adalah atribut yang ditentukan sistem. Anda dapat menentukan nilai default kustom untuk atribut ini di Kelola atribut.
- Atribut yang ditentukan pengguna: Ini adalah atribut kustom yang ditentukan pengguna. Anda dapat menentukan atribut khusus di Mengelola atribut.
Klik Simpan.

REST

Untuk mengedit resource API, gunakan Patch API resource API.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
          "display_name": "Updated Test Docs API",        # Example request body with changes
          "description": "This is the updated test API.",
          "owner": {
            "display_name": "Updated Docs Owner",
            "email": "updateddocsowner@gmail.com"
            }
          }
          ' https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID

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 API hub disediakan.
API_ID: ID unik API yang akan diperbarui.
Request Body: Gunakan request body untuk menentukan atribut yang ingin diubah. Lihat deskripsi isi permintaan API.