Mendesain dan mengedit API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Apigee Edge dokumentasi.

Halaman ini memberikan petunjuk tentang cara mendesain dan mengedit API di Apigee di Cloud Code.

Sebelum memulai

Sebelum menggunakan fungsi dalam panduan ini, pastikan Anda telah menyelesaikan langkah-langkah penyiapan untuk Menyiapkan Pengelolaan API Apigee di Cloud Code untuk VS Code, termasuk memastikan akun pengguna Anda memiliki peran yang diperlukan yang tercantum dalam Peran yang diperlukan untuk menggunakan hub API Apigee dengan pengembangan lokal Apigee.

Mendesain API

Anda dapat menambahkan dan mengedit proxy API Apigee dan API hub API langsung di Cloud Code.

• Buat proxy API Apigee dengan mengikuti langkah-langkah di Membuat proxy API.
• Buat API hub API dengan mengklik ikon plus di baris untuk host hub API Anda. Tindakan ini akan membuka jendela pengeditan spesifikasi dan panel Swagger untuk spesifikasi API baru dan memungkinkan Anda memublikasikan API ke hub API Anda.

Tips: Anda juga dapat menggunakan chat Gemini Code Assist untuk membuat spesifikasi OpenAPI, lalu menyalinnya untuk digunakan di Apigee. Untuk mengetahui informasi, lihat Membuat kode dengan Gemini Code Assist Standard dan Enterprise. Setelah penyiapan, masukkan perintah seperti

Create an OpenAPI spec for an API that lets customers schedule appointments with a dental office.

Spesifikasi yang dibuat dengan cara ini tidak menggabungkan konteks perusahaan dari hub API Anda.

Mengedit API

Anda dapat mengedit API yang telah disimpan secara lokal atau dari hub API katalog Anda. Perubahan yang Anda buat di Cloud Code dapat dipublikasikan ke hub API atau disimpan sebagai paket proxy API Apigee.

Terlepas dari metode yang Anda gunakan untuk mengedit API, Anda dapat memperbarui spesifikasi secara manual, atau menggunakan Chat Gemini Code Assist (jika diaktifkan) untuk melakukan iterasi pada spesifikasi. Perhatikan bahwa saat menggunakan Chat Gemini Code Assist untuk melakukan iterasi pada spesifikasi, saran Gemini Code Assist tidak menyertakan konteks perusahaan dari hub API Anda.

Mengedit spesifikasi API dari hub API

Untuk mengedit spesifikasi API yang disimpan di katalog hub API Anda, ikuti petunjuk di bagian ini. Agar dapat terintegrasi dengan hub API, project Apigee Anda harus disediakan dengan hub API. Lihat Sebelum memulai.

1. Pastikan project yang Anda pilih di Cloud Code adalah project dengan katalog hub API yang berisi API yang ingin Anda edit.
2. Di navigasi kiri, luaskan hierarki API Hub di bagian Apigee.
3. Pilih API dan versi yang akan diedit dari daftar. Anda akan melihat file YAML dan tampilan panel Swagger panel untuk API.

Mengedit spesifikasi API yang disimpan secara lokal

Untuk mengedit spesifikasi API yang disimpan secara lokal, buka file di Cloud Code.

Jika telah membuat paket proxy Apigee dari spesifikasi, Anda dapat membuka file paket proxy di Cloud Code dengan mengklik nama proxy API di bagian apiproxies di ruang kerja Apigee Anda.

Menyimpan API sebagai paket proxy API

Anda dapat menyimpan API sebagai paket proxy API Apigee sehingga dapat menggunakannya dalam lingkungan pengembangan lokal Apigee Anda. Untuk mengetahui informasi tentang cara menggunakan proxy API di Cloud Code, lihat Mengembangkan proxy API.

1. Klik Create API proxy bundle di panel Swagger.
2. Di kolom perintah, beri nama proxy API Anda dan lanjutkan.
3. Proxy API Anda akan muncul di menu kiri Apigee di ruang kerja lokal Anda, di bagian apiproxies.

Memublikasikan API ke hub API

Jika menggunakan hub API, Anda dapat menyediakan API Anda untuk developer lain dengan mendaftarkannya ke hub API:

1. Di panel Swagger untuk spesifikasi API baru atau yang diedit, klik Publish to API hub.
2. Dalam formulir, berikan metadata untuk API guna meningkatkan kemampuan penemuan dan organisasi API dalam katalog hub API Anda. Sebagian besar kolom diisi otomatis dari spesifikasi API, tetapi Anda dapat mengubah nilainya. Lihat Mendaftarkan API untuk informasi tentang cara mendaftar ke hub API dan informasi yang perlu Anda berikan.
   • API Display Name (Wajib): Nama API, yang terlihat oleh developer lain.
   • Deskripsi API (Opsional): Deskripsi API untuk referensi internal/developer referensi.
   • API Owner Name (Opsional): Nama pemilik API.
   • API Owner Email (Opsional): Alamat email pemilik.
   • API Version (Wajib): Versi API.
   • Lifecycle Stage (Opsional): Pilih tahap dari daftar.
3. Klik Publish untuk memublikasikan API ke hub API.
4. Setelah jeda singkat, perubahan Anda akan terlihat di hierarki API Hub di bagian Apigee Cloud Code.

Menguji API menggunakan server tiruan

Anda dapat menguji API menggunakan server tiruan lokal atau server tiruan jarak jauh berbasis Google Cloud. Server tiruan lokal diinstal dan tersedia secara default, sedangkan Anda harus menyiapkan dan mengelola Google Cloud server tiruan.

Menggunakan server tiruan lokal

Server tiruan lokal menerima permintaan ke API ini dan meniru respons. Server ini hanya dapat digunakan selama sesi saat ini oleh pengguna saat ini. Namun, tidak seperti server tiruan jarak jauh, server ini tidak memerlukan penyiapan atau pengelolaan dan tidak dikenai biaya.

Selain itu, server tiruan lokal:

• Tidak berfungsi saat menggunakan Cloud Shell Editor atau Cloud Workstations.
• Mungkin tidak berfungsi dengan benar saat menggunakan VS Code Remote Explorer.

Untuk menggunakan server tiruan lokal:

1. Pilih server tiruan lokal di dropdown Servers (jika belum dipilih):
   
2. Buka jalur di panel Swagger dan klik Try it out.
   
3. Isi parameter permintaan apa pun dan klik Execute.
   

Menggunakan server tiruan jarak jauh

Server tiruan jarak jauh memberikan kemampuan untuk membuat instance server tiruan persisten yang, tidak seperti server tiruan lokal, dapat dibagikan dan digunakan oleh orang lain dalam organisasi Anda untuk menguji API baru. Server tiruan jarak jauh hanya dapat digunakan dengan API yang terdaftar di hub API.

Server tiruan jarak jauh tidak otomatis diperbarui untuk perubahan apa pun yang Anda lakukan pada API setelah men-deploy server tiruan, jadi tunggu hingga Anda sepenuhnya membuat API sebelum menambahkan server tiruan.

Men-deploy server tiruan jarak jauh akan membuat layanan Cloud Run baru. Google Cloud Layanan ini membangun image container untuk server tiruan menggunakan Cloud Build dan mengupload image container ke Cloud Artifact Registry di project Google Anda. Lihat Apa yang dimaksud dengan Cloud Run?, Mengelola Layanan, dan dokumentasi Artifact Registry.

Anda dapat menggunakan akun layanan default atau memberikan akun layanan yang lebih terbatas untuk men-deploy aplikasi Cloud Run. Lihat Mengelola Cloud API dan Library Klien Cloud di Cloud Code untuk VS Code untuk mengetahui informasi.

Penting: Anda bertanggung jawab atas biaya dan pemeliharaan yang dihasilkan di server tiruan jarak jauh setelah pembuatan. Anda juga bertanggung jawab untuk menghapusnya setelah tidak diperlukan atau digunakan lagi. Lihat Harga Cloud Run untuk informasi harga, termasuk informasi tentang opsi paket gratis.

Untuk men-deploy server tiruan jarak jauh:

1. Pilih Deploy mock server dari panel Swagger.
2. Jika API Anda belum terdaftar di hub API, daftarkan saat diminta.
3. Tentukan detail untuk server tiruan jarak jauh: Server Name, Secure Server, Service Account (biarkan kosong untuk menggunakan akun layanan default), dan apakah akan menambahkan URL server ke spesifikasi API. Klik Create untuk membuat server tiruan jarak jauh.
   Penting: Jangan membuat beberapa server tiruan jarak jauh dengan nama yang sama, meskipun antarmuka pengguna tidak akan mencegah Anda melakukannya saat ini.
4. Pembuatan server tiruan jarak jauh memerlukan waktu beberapa menit. Anda dapat melihat progres di panel OUTPUT Cloud Code dan melalui pop-up notifikasi di sudut kanan bawah VS Code.
5. Setelah proses pembuatan server tiruan jarak jauh selesai, Anda akan melihat URL server jarak jauh di daftar server panel Swagger dan panel OUTPUT.
6. Untuk menggunakan server tiruan, buka jalur dan klik Try it out.
   
   
   Isi parameter permintaan apa pun dan klik Execute.
   
   
   Anda juga dapat mengirim permintaan menggunakan curl dari perintah. Gunakan alamat dan port server dari Servers dropdown.

Untuk membagikan akses ke server tiruan kepada pengguna lain:

1. Berikan peran pemanggil kepada pengguna lain untuk layanan yang di-deploy. Lihat Mengautentikasi developer.
2. Saat membuat permintaan ke server tiruan, pengguna mengikuti petunjuk di Menguji layanan pribadi Anda.

Untuk mengelola server tiruan jarak jauh yang di-deploy:

1. Buka Hub API Apigee.
2. Temukan API untuk melihat semua deployment untuk API, yang mencakup server tiruan jarak jauh.
3. Gunakan Resource URL untuk membuka deployment dan mengelolanya dengan menghentikan, menghapus, dan melakukan tindakan lain di server tiruan.