Bagikan melalui

Merancang dan mengembangkan API menggunakan plugin API Center untuk GitHub Copilot untuk Azure

  • Artikel

Plugin API Center untuk GitHub Copilot for Azure (pratinjau) mempercepat desain dan pengembangan API baru mulai dari permintaan bahasa alami. Dengan bantuan AI yang tersedia melalui plugin API Center yang dikombinasikan dengan ekstensi API Center VS Code, cukup jelaskan API Anda dan hasilkan spesifikasi OpenAPI dengan cepat untuk pengembangan API yang sesuai dengan standar organisasi Anda. Setelah membuat spesifikasi yang sesuai, Anda dapat mendaftarkan API dengan pusat API Anda.

Catatan

Fitur ini tersedia dalam versi pra-rilis ekstensi API Center.

Prasyarat

Penyiapan ekstensi

  1. Instal ekstensi Azure API Center untuk Visual Studio Code dari Visual Studio Code Marketplace. Instal ekstensi lain yang tercantum dalam Prasyarat.

    Catatan

    Jika disebutkan, fitur tertentu hanya tersedia di versi pra-rilis ekstensi Azure API Center. Saat menginstal ekstensi dari Visual Studio Code Marketplace, Anda dapat memilih untuk menginstal versi rilis atau versi pra-rilis. Beralih di antara dua versi kapan saja dengan menggunakan menu konteks tombol Kelola ekstensi dalam tampilan Ekstensi.

  2. Di Visual Studio Code, di Bilah Aktivitas di sebelah kiri, pilih PUSAT API.

    Cuplikan layar ekstensi API Center di bilah aktivitas.

  3. Jika Anda tidak masuk ke akun Azure Anda, pilih Masuk ke Azure..., dan ikuti perintah untuk masuk. Pilih langganan Azure dengan pusat API (atau pusat API) tempat Anda ingin melihat API. Anda juga dapat memfilter langganan tertentu jika Anda memiliki banyak untuk dilihat.

Membuat permintaan ke @azure agen

Ikuti langkah-langkah ini untuk menghasilkan spesifikasi OpenAPI menggunakan perintah bahasa alami dengan GitHub Copilot untuk Azure:

  1. Jika diinginkan, atur panduan gaya API aktif di ekstensi Azure API Center. Gunakan pintasan keyboard Ctrl+Shift+P untuk membuka Palet Perintah. Ketik Azure API Center: Atur Panduan Gaya API, buat pilihan, dan tekan Enter.

    Jika tidak ada panduan gaya yang diatur, kumpulan aturan default spectral:oas akan digunakan. Pelajari selengkapnya tentang linting spesifikasi API menggunakan ekstensi API Center.

  2. Di panel obrolan, buat permintaan dalam bahasa alami kepada @azure agen untuk menjelaskan apa yang dilakukan API. Contoh:

    @azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.

    Copilot didukung oleh AI, sehingga kejutan dan kesalahan dimungkinkan. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Copilot.

    Agen merespons dengan dokumen spesifikasi OpenAPI.

    Cuplikan layar memperlihatkan cara menggunakan ekstensi @azure untuk menghasilkan spesifikasi OpenAPI dari perintah.

  3. Tinjau output yang dihasilkan untuk akurasi, kelengkapan, dan kepatuhan dengan panduan gaya API Anda.

    Perbaiki perintah jika diperlukan untuk meregenerasi spesifikasi, atau ulangi proses menggunakan panduan gaya berbeda yang Anda tetapkan di ekstensi Azure API Center.

    Tip

    Permintaan efektif berfokus pada persyaratan bisnis API daripada detail implementasi. Perintah yang lebih pendek terkadang bekerja lebih baik daripada yang lebih panjang.

  4. Saat memenuhi kebutuhan Anda, simpan spesifikasi OpenAPI yang dihasilkan ke file.

Mendaftarkan API di pusat API Anda

Gunakan ekstensi Azure API Center untuk VISUAL Code untuk mendaftarkan API di pusat API Anda dari file spesifikasi yang dihasilkan. Setelah mendaftarkan API, Anda dapat menggunakan ekstensi untuk melihat dokumentasi API, menghasilkan klien HTTP, melakukan linting dan analisis lebih lanjut, dan banyak lagi.

  1. Di Visual Studio Code, pilih tombol Daftarkan API Anda di API Center di panel obrolan, atau pilih Azure API Center: Daftarkan API dari Palet Perintah.

  2. Pilih Manual.

  3. Pilih pusat API untuk mendaftarkan API.

  4. Jawab permintaan dengan informasi termasuk judul API, jenis, judul versi, siklus hidup versi, judul definisi, nama spesifikasi, dan file definisi (spesifikasi) untuk menyelesaikan pendaftaran API.

Setelah API terdaftar, Anda dapat melakukan berbagai tugas menggunakan ekstensi. Misalnya, lihat dokumentasi API di antarmuka pengguna Swagger:

  1. Perluas tampilan pohon PUSAT API untuk memilih definisi untuk versi API yang Anda daftarkan.

  2. Klik kanan pada definisi, dan pilih Buka Dokumentasi API. Tab baru muncul dengan antarmuka pengguna Swagger untuk definisi API.

Cuplikan layar UI Swagger di ekstensi Visual Studio Code.

Konten terkait