Tutorial: Menggunakan Gemini Code Assist untuk merancang, mengembangkan, dan menguji API di Apigee dan Cloud Code

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Pratinjau — Gemini Code Assist

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.

Ringkasan

Tutorial ini memandu Anda melalui proses penggunaan Gemini Code Assist di Cloud Code untuk mendesain API dan membuat proxy Apigee API dari spesifikasi API yang dihasilkan. Dalam tutorial ini, Anda akan menggunakan perintah natural language untuk merancang dan membuat API yang mengelola postingan blog terkait olahraga untuk sebuah situs.

Penting: Karena sifat AI generatif, konten yang dihasilkan yang menggunakan Gemini Code Assist mungkin tidak sama persis dengan output yang ditunjukkan dalam tutorial ini. Selain itu, jika Anda menggunakan project dengan hub API, konteks perusahaan di hub API mungkin memengaruhi spesifikasi yang dihasilkan sehingga berbeda dari contoh hasil yang ditampilkan dalam tutorial ini.

Sebelum memulai

Untuk menyelesaikan tutorial ini, Anda akan memerlukan:

• Cloud AI Companion API telah disiapkan untuk project Apigee Anda, atau menjadi Admin Org Apigee agar Anda dapat menambahkannya. Untuk mengetahui langkah-langkah penyiapan Gemini Code Assist, lihat Menggunakan Gemini Code Assist.
• Menjadi Admin API Apigee di project Apigee Anda.
• Jika Anda belum menyiapkan pengembangan lokal untuk project Apigee di Cloud Code. Lihat Menyiapkan Pengelolaan API Apigee di Cloud Code untuk VS Code.
• Pemahaman terhadap spesifikasi OpenAPI, sehingga Anda dapat meninjau spesifikasi yang dihasilkan.
• (Opsional) Hub API disiapkan untuk project ini. Meskipun tidak sepenuhnya diwajibkan untuk menggunakan fitur Gemini Code Assist yang dijelaskan di sini, Anda tidak akan dapat melakukan semua langkah tanpa hub API.

Langkah 1: Muat Apigee di Cloud Code

Buka VS Code dan klik ikon Cloud Code. Anda akan melihat project Apigee dan API apa pun.

Langkah 2: Buka tab Create an API spec dan masukkan perintah

Klik tongkat ajaib di baris Apigee untuk membuka tab pembuatan spesifikasi.

Tab ini menampilkan template yang dapat Anda gunakan untuk memulai perintah API. Kolom input perintah bentuk bebas tersedia di bawahnya. Klik API untuk konten blog. Perintah natural language yang menjelaskan API ini akan mengisi kolom input perintah.

Langkah 3: Buat dan lihat spesifikasi

Klik Create untuk membuat spesifikasi API dari perintah ini. Tunggu selagi spesifikasi dihasilkan; panel Output akan menampilkan langkah-langkahnya saat spesifikasi dibuat.

Setelah dibuat, lihat deskripsi spesifikasi, endpoint, dan skema dengan men-scroll ke bawah. Untuk melihat kode spesifikasi OpenAPI, klik View code.

Langkah 4: Ubah perintah dan buat ulang spesifikasi

Kembali ke perintah dan tambahkan jenis olahraga sebagai bagian dari objek data.

Klik Create lagi untuk membuat ulang spesifikasi. Anda akan melihat jenis olahraga dalam spesifikasi yang diupdate.

Perlu diperhatikan bahwa Anda juga dapat kembali ke perintah sebelumnya dengan mengklik histori perintah di bagian atas kotak input perintah.

Langkah 5: Edit spesifikasi

Anda dapat mengubah spesifikasi dengan mengklik View Code dan mengetikkan pembaruan Anda langsung di spesifikasi. Untuk contoh ini, ubah deskripsi menjadi "Sports Blog Post Content Management API".

Langkah 6: Uji API menggunakan server tiruan

Uji API menggunakan server tiruan lokal, yang mengemulasi respons untuk API. Di menu drop-down Servers, pilih opsi dengan Local development server sebagai namanya. Setelah dipilih, buka jalur POST dan klik Try it out.

Catatan: Server tiruan lokal mungkin tidak berfungsi dengan benar saat menggunakan VS Code Remote Explorer. Selain itu, terkadang server tiruan lokal tidak dapat dimulai. Dalam hal ini, nama tersebut tidak akan tersedia di daftar server.

Ubah nilai "author", "content", dan "title" dalam isi permintaan untuk menggunakan nilai Anda sendiri:

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

Klik Execute untuk melihat respons tiruan dari API di bagian Respons.

Langkah 7: Simpan API ke hub API

(Opsional) Setelah API Anda ditinjau dan dinyatakan final, sediakan API tersebut untuk developer dengan mendaftarkannya ke hub API:

1. Klik Register to API hub.
2. Ikuti petunjuk untuk mendaftarkan API. Lihat Mendaftar API untuk mendapatkan informasi tentang cara mendaftar dengan hub API dan informasi yang perlu Anda berikan.

Klik Save untuk menyimpan API baru dengan nama pilihan Anda.

Langkah 8: Buat paket proxy API dari spesifikasi ini

Untuk membuat paket proxy Apigee API dari spesifikasi ini, klik Create API proxy bundle dari menu Lainnya. Setelah dibuat, Anda akan melihat proxy baru di bagian apiproxies di menu kiri. Lihat Mengembangkan proxy API untuk mengetahui informasi tentang cara menggunakan proxy API di Cloud Code.

Langkah berikutnya

• Pelajari lebih lanjut cara mendesain dan mengedit API menggunakan Cloud Code.
• Pelajari lebih lanjut fitur Gemini Code Assist yang dapat Anda gunakan di Apigee. Lihat Menggunakan Gemini.