Menyiapkan Pengelolaan API Apigee di Cloud Code untuk VS Code

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Halaman ini memberikan petunjuk untuk membuat lingkungan pengembangan lokal Pengelolaan API Apigee di Cloud Code untuk VS Code, yang mendukung Gemini Code Assist untuk desain dan pengembangan spesifikasi OpenAPI. Lihat Ringkasan pengembangan lokal dengan Apigee untuk mengetahui fitur di lingkungan pengembangan lokal.

Proses penyiapan memerlukan penyelesaian kedua bagian dalam panduan ini:

Bergantung pada kasus penggunaan Anda, selesaikan juga satu atau kedua bagian berikut:

Sebelum memulai

Untuk menyiapkan dan menggunakan Apigee di VS Code, Anda memerlukan:

  1. Project Google Cloud untuk login di lingkungan pengembangan lokal Anda. Project ini tidak perlu disediakan untuk Apigee agar dapat menggunakan Gemini Code Assist untuk mengembangkan spesifikasi API, tetapi perlu disediakan untuk Apigee agar dapat membuat ruang kerja lokal Apigee tempat Anda dapat mengembangkan dan menguji proxy API. Penyediaan Apigee juga diperlukan untuk melihat API API hub Apigee di bagian Apigee di Cloud Code.
  2. (Direkomendasikan) API hub yang disediakan di project Anda. Hub API diperlukan untuk fitur berikut: Jika tidak ingin menambahkan API Hub ke project, Anda dapat mengaitkan project tersebut dengan project lain yang mengaktifkan API Hub. Lihat Melampirkan project runtime ke API Hub untuk mengetahui informasi tentang cara melampirkan project ke API Hub.
  3. Peran yang diperlukan untuk menggunakan Gemini Code Assist di Apigee untuk tindakan yang ingin Anda lakukan. Anda harus memiliki peran Service Usage Admin di akun pengguna agar project dapat menyiapkan Gemini Code Assist.
  4. Memahami VS Code, cara mengelola VS Code, dan cara melakukan tindakan umum seperti mengakses setelan dan menginstal ekstensi. Lihat dokumentasi VS Code.

Menginstal VS Code dan ekstensi Cloud Code

Bagian ini memberikan petunjuk penginstalan untuk menginstal VS Code dan ekstensi Cloud Code di VS Code. Ini adalah langkah pertama dalam menyiapkan pengembangan lokal untuk Apigee dan diperlukan untuk menggunakan fitur pengembangan lokal Apigee, termasuk Gemini Code Assist.

Untuk menginstal VS Code dan ekstensi Cloud Code:

  1. Download dan instal Visual Studio Code (VS Code) di komputer lokal, jika belum diinstal.
  2. Instal ekstensi Cloud Code, seperti yang dijelaskan dalam Menginstal ekstensi Cloud Code. Jika Anda berencana mengelola proxy API di lingkungan lokal, instal Docker sebagai bagian dari prosesnya.
  3. (Direkomendasikan) Aktifkan update otomatis untuk ekstensi Cloud Code. Di Setelan, telusuri Extensions: Auto Update dan aktifkan untuk semua ekstensi atau untuk ekstensi Cloud Code satu per satu.
  4. Mulai ulang VS Code.

Menyiapkan Gemini Code Assist untuk Apigee

Ikuti langkah-langkah berikut untuk menyiapkan Gemini Code Assist untuk Apigee di lingkungan pengembangan lokal Anda. Perhatikan Peran yang diperlukan untuk menggunakan Gemini Code Assist di Apigee.

  1. Pastikan Anda telah menyelesaikan langkah-langkah di bagian Menginstal VS Code dan ekstensi Cloud Code, jika belum selesai.
  2. Instal ekstensi Gemini Code Assist di VS Code.
  3. (Direkomendasikan) Aktifkan update otomatis untuk ekstensi Gemini Code Assist. Di Setelan, telusuri Extensions: Auto Update dan aktifkan untuk semua ekstensi atau untuk ekstensi Gemini Code Assist satu per satu.
  4. Jika belum diinstal, instal gcloud CLI.
  5. Aktifkan Gemini for Google Cloud API untuk project. Anda memerlukan peran Admin Penggunaan Layanan untuk melakukan langkah ini.
    gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT
  6. Di VS Code, login ke project Google Cloud Anda di kedua ekstensi Gemini Code Assist dan Cloud Code. Anda dapat melakukannya menggunakan salah satu metode berikut:
    • Tambahkan project secara manual di file settings.json Anda:
      {
        "cloudcode.apigee.gemini.options": {
            "cloudcode.project": "YOUR_PROJECT",
            "geminicodeassist.project": "YOUR_PROJECT"
          ...
          }
        }
    • Pilih project saat diminta:

      Jika Anda membuka chat Gemini Code Assist dan tidak login ke project yang mengaktifkan Gemini, Anda akan melihat pesan yang menjelaskan hal tersebut beserta cara login. Pilih pilih Google Cloud project untuk menambahkan Project.
      Gemini Code Assist untuk Chat Gemini Code Assist tidak memiliki project

      Untuk memilih project untuk Google Cloud dari dalam bagian Apigee di Cloud Code, luaskan bagian API hub dan klik Cloud Code - No Project selected:
      Google Cloud no project

      Atau, klik nama project di status bar Cloud Code dan pilih project baru: Status bar Cloud Code yang menampilkan project Apigee
  7. Tambahkan Peran yang diperlukan untuk menggunakan Gemini Code Assist di Apigee yang diperlukan ke akun pengguna Anda.
  8. Jika Anda ingin dapat membuat paket proxy API dari spec OpenAPI dan mengelolanya di lingkungan pengembangan lokal, selesaikan langkah-langkah di Menyiapkan lingkungan pengembangan lokal untuk pengembangan proxy API.

Peran yang diperlukan untuk menggunakan Gemini Code Assist di Apigee

Anda memerlukan peran yang tercantum di bawah untuk melakukan langkah-langkah desain dan pengujian API menggunakan Gemini Code Assist:

Tugas Peran yang Diperlukan
Mendesain API menggunakan Gemini Code Assist Pengguna Gemini untuk Google Cloud
Konsumen Penggunaan Layanan

Lihat Memberikan peran IAM di project Google Cloud untuk Gemini Code Assist.
Menggunakan konteks perusahaan dari API yang ada di API Hub saat mendesain API Cloud API Hub Viewer
Mengedit API hub API Cloud API Hub Editor atau Admin
Memublikasikan API ke API hub Cloud API Hub Editor atau Admin
Menyiapkan dan mengelola server tiruan jarak jauh untuk menguji API Administrator Artifact Registry
Akun Layanan Cloud Build
Admin Cloud Run
Admin Penggunaan Layanan

Lihat Referensi peran dasar dan standar IAM.

Anda juga harus menginstal gcloud CLI.

Menyiapkan pengembangan proxy API untuk pengembangan lokal Apigee

Selesaikan langkah-langkah di bagian ini jika Anda ingin menggunakan lingkungan pengembangan lokal untuk pengembangan dan pengujian proxy Apigee API. Selesaikan juga langkah-langkah ini agar dapat membuat proxy API dari spesifikasi OpenAPI.

  1. Buat ruang kerja Apigee.
  2. Instal Apigee Emulator.
  3. Tambahkan penampung untuk di-deploy ke Apigee Emulator.

Langkah berikutnya

Setelah menyelesaikan langkah-langkah penginstalan dan penyiapan, mulai gunakan Cloud Code: