Mendaftarkan API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Pratinjau — Apigee API hub

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Mendaftarkan API akan membuatnya dapat ditemukan oleh pelihat di daftar API.

Izin yang diperlukan: Anda harus memiliki izin edit atau administrator untuk register, mengedit, atau menghapus pendaftaran API.

Mendaftarkan API

Untuk mendaftarkan API:

1. Di konsol Google Cloud, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Klik Register API. Panel Register API akan terbuka.
3. Tentukan detail API berikut:
   • ID: ID untuk resource API. ID hanya boleh berisi huruf kecil, angka, dan tanda hubung. ID dalam project harus unik. Panjang ID harus antara 4 dan 63 karakter. ID tidak dapat diubah setelah API didaftarkan. Misalnya, untuk nama resource API: projects/my-project/locations/global/apis/my-api, ID resource-nya adalah my-api.
   • Nama: Masukkan nama API
   • Deskripsi: Masukkan deskripsi API
   • Gaya:
   • Gaya: Pilih gaya arsitektur utama API (misalnya, OpenAPI, GraphQL, AsyncAPI, dsb., bergantung pada cara hub API dikonfigurasi).
   • Dokumen deskripsi API: Jika Anda sudah memiliki dokumen deskripsi, klik Browse untuk menguploadnya. Ini dapat berupa file tunggal atau file zip (maks. 2 MB). Untuk informasi cara menambahkan dan menghapus revisi, lihat Mengelola revisi.
   • MIME type: Pilih MIME type. Jenis MIME ditampilkan setelah Anda memilih dokumen deskripsi API. Jika Anda memilih Other, kolom teks akan ditampilkan dan Anda dapat menentukan jenis MIME secara manual.
   • Versi saat ini:
     • ID Versi: Nama untuk resource API. ID Versi hanya boleh berisi huruf kecil, angka, dan tanda hubung. ID Versi harus unik dalam project. Panjang ID versi harus antara 1 dan 63 karakter. ID versi tidak dapat diubah setelah API didaftarkan.
     • Version: Masukkan versi awal
     • Tahap siklus proses API: Pilih tahap siklus proses dari daftar.
   • Masa akhir yang diharapkan:
     • Pilih Ekspektasi dari daftar.
     • Jika Ekspektasi adalah Minimum date, tentukan Date.
     • Jika Expectation adalah Confirmed date, tentukan Date.
   • Properti:
     • Taksonomi sistem:

       • Pengguna target: Pilih pengguna (konsumen) yang dituju untuk API

       • Tim: Pilih tim yang bertanggung jawab untuk membuat API
       • Unit bisnis: Pilih unit bisnis yang bertanggung jawab untuk API
     • Taksonomi kustom:
       Catatan: Mungkin ada properti khusus tambahan yang tersedia.
       • Pilih taksonomi kustom lainnya yang tercantum
   • Kontak utama:
     • Alamat email kontak utama: Alamat email kontak utama untuk pertanyaan tentang API
     • Deskripsi kontak utama: Deskripsi kontak utama
4. Klik Register API (atau Cancel).

Mengedit detail pendaftaran API

Untuk mengedit detail pendaftaran API:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Klik API. Halaman API Overview akan terbuka.
3. Klik Edit.
   Izin yang diperlukan: Jika tidak dapat melihat link Edit, berarti Anda tidak memiliki izin edit.
4. Ubah detail.
5. Klik Simpan (atau Batal).

Menghapus API

Catatan: Setiap API harus memiliki versi yang direkomendasikan yang tidak dapat dihapus.

Menghapus API akan menghapusnya dari sistem. Jika API mungkin merupakan kepentingan historis bagi orang lain, daripada menghapusnya, pertimbangkan untuk menggunakan tahap siklus proses Pensiunan atau Tidak digunakan lagi.

Cara menghapus API:

1. Di Cloud Console, buka halaman API hub.

   Buka hub API

   Halaman daftar APIs ditampilkan secara default.

2. Klik API. Halaman API Overview akan terbuka.
   
3. Klik Delete API.
   Izin yang diperlukan: Jika tidak dapat melihat link Hapus API, berarti Anda tidak memiliki izin edit.

4. Dialog konfirmasi akan ditampilkan. Ketik nama API, lalu klik Confirm (atau Cancel).