Pengantar dependensi

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Dependensi hub API membantu Anda melihat dan mengelola hubungan antara operasi API. Menemukan dan melacak dependensi API akan membantu Anda mengelola ekosistem API dengan lebih efisien. Misalnya, dependensi dapat membantu Anda menemukan potensi dampak dari mengubah atau menghentikan penggunaan API, memecahkan masalah, atau menganalisis kepatuhan terhadap peraturan biaya atau kepatuhan. API dapat disimpan di dalam hub API atau di luar hub API.

Apa itu dependensi?

Hub API memodelkan dependensi sebagai hubungan terarah antara operasi API, dengan satu operasi API adalah supplier dan satunya lagi sebagai konsumen. Sebagai contoh, misalkan PetStore API memanggil operasi di Location API. Dalam hal ini, PetStore API bergantung pada operasi yang disediakan oleh Location API. Di hub API, kami menyebut PetStore sebagai konsumen dan Lokasi sebagai pemasok.

Gambar 1 mengilustrasikan hubungan pemasok/konsumen antara operasi API. Operasi /debit Payment API menggunakan operasi /detect Fraud Detection API. Operasi debit adalah konsumen, dan operasi deteksi penipuan adalah pemasok dalam hubungan ini.

Demikian pula, /detect menggunakan operasi yang disediakan oleh UserProfile API dan GeoLocation API. Dalam hal ini, operasi /detect adalah konsumen dan dua lainnya adalah pemasok.

Dependensi hub API Dependensi hub API

Gambar 1. Pemetaan dependensi API

Membuat dependensi

Langkah-langkah dasar untuk membuat dependensi di hub API adalah:

  1. Temukan dua API yang mungkin memiliki dependensi yang ingin Anda lacak.
  2. Cantumkan versi kedua API menggunakan List Versions API. Atau, Anda dapat menggunakan List Operations API dan memfilter hasil untuk menemukan operasi yang dependen.
  3. Menentukan operasi mana yang merupakan pemasok dan mana yang merupakan konsumen. Seperti yang telah dibahas sebelumnya, operasi konsumen memanggil operasi dari pemasok.
  4. Gunakan Create Dependency API untuk membuat dependensi antara operasi pemasok dan operasi konsumen.

Untuk detail tentang cara memanggil Create Dependency API dan contohnya, lihat Membuat Dependency API.

Menemukan dependensi

List Dependency API adalah cara yang baik untuk menemukan dependensi di hub API. API memungkinkan Anda memfilter berdasarkan atribut kunci, termasuk nama operasi sumber, nama operasi tujuan, dan status dependensi.

Langkah-langkah dasar untuk menemukan dependensi adalah:

  1. Gunakan List Dependency API untuk mencantumkan semua dependensi atau gunakan fitur filter API untuk mempersempit penelusuran Anda.
  2. Gunakan Get Dependency API untuk melihat perincian dependensi yang rusak guna menemukan detail selengkapnya seperti nama pemasok.

Berikut ini contoh panggilan API untuk mencantumkan dependensi: 

curl "https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Mengidentifikasi dependensi yang rusak

Untuk mengidentifikasi dependensi yang rusak, ikuti langkah-langkah dasar berikut:

  1. Gunakan List Dependency API untuk mencantumkan semua dependensi atau gunakan fitur filter API untuk mempersempit penelusuran Anda.
  2. Identifikasi dependensi yang ditampilkan mana yang memiliki set flag error.
  3. Gunakan Get Dependency API untuk melihat perincian dependensi yang rusak guna menemukan detail selengkapnya seperti nama pemasok.

    Berikut adalah contoh respons, dengan kondisi error yang menunjukkan bahwa operasi pemasok telah dihapus:

    {
  "name": "projects/common-dev-15/locations/us-central1/dependencies/user-to-pet",
  "consumer": {
      "displayName": "POST - /v2/user",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/createuser"
  },
  "supplier": {
      "displayName": "POST - /v2/pet",
      "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/addpet"
  },
  "state": "VALIDATED",
  "description": "Dependency from user to pet API",
  "discoveryMode": "MANUAL",
  "createTime": "2024-04-17T19:33:31.215978712Z",
  "updateTime": "2024-04-17T19:33:31.737505297Z",
  {
    "error": "SUPPLIER_NOT_FOUND",
    "errorTime": 2024-05-18T20:23:42.465324Z
  }
}

Operasi dependensi lainnya

Setelah membuat dependensi, Anda dapat menggunakan API hub API untuk mendapatkan detail dependensi, menemukan dependensi dengan memfilter daftar semua dependensi dalam hub API, menghapus dependensi, dan memperbarui deskripsi dependensi. Semua Dependency API dijelaskan secara mendetail dalam referensi API dan di Mengelola dependensi.