Bagikan melalui

Membangun dan mendaftarkan API dengan ekstensi Azure API Center untuk Visual Studio Code

Pengembang produsen API di organisasi Anda dapat membangun dan mendaftarkan API di inventarisasi pusat API Anda dengan menggunakan ekstensi Azure API Center untuk Visual Studio Code. Pengembang API dapat:

  • Tambahkan API yang ada ke pusat API sebagai operasi satu kali, atau integrasikan alur pengembangan untuk mendaftarkan API sebagai bagian dari alur kerja CI/CD.
  • Gunakan GitHub Copilot untuk menghasilkan spesifikasi OpenAPI baru dari kode API.

Pengembang konsumen API juga dapat memanfaatkan fitur dalam ekstensi untuk menemukan dan menggunakan API di pusat API dan memastikan tata kelola API.

Prasyarat

Ekstensi Visual Studio Code berikut diperlukan untuk skenario yang ditentukan:

  • GitHub Actions untuk mendaftarkan API menggunakan alur CI/CD dengan GitHub Actions
  • Azure Pipelines untuk mendaftarkan API menggunakan alur CI/CD dengan Azure Pipelines
  • GitHub Copilot untuk menghasilkan file spesifikasi OpenAPI dari kode API

Penyiapan ekstensi

  1. Instal ekstensi Azure API Center untuk Visual Studio Code dari Visual Studio Code Marketplace. Instal ekstensi lain sesuai kebutuhan.

    Nota

    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 API Center.

    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 langganan untuk dipilih.

Mendaftarkan API secara manual

Langkah-langkah berikut mendaftarkan API di pusat API Anda sebagai operasi satu kali.

  1. Gunakan pintasan keyboard Ctrl+Shift+P untuk membuka Palet Perintah. Ketik Azure API Center: Daftarkan API dan tekan Enter.
  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 untuk menyelesaikan pendaftaran API.

API ditambahkan ke inventaris pusat API Anda.

Mendaftarkan API menggunakan alur CI/CD

Langkah-langkah berikut mendaftarkan API di pusat API Anda dengan alur CI/CD. Dengan opsi ini, tambahkan alur GitHub atau Azure DevOps yang telah dikonfigurasi sebelumnya ke ruang kerja Visual Studio Code aktif Anda yang dijalankan sebagai bagian dari alur kerja CI/CD pada setiap penerapan ke kontrol sumber. Disarankan untuk inventaris API dengan pusat API Anda menggunakan CI/CD untuk memastikan metadata API termasuk spesifikasi dan versi tetap terkini di pusat API Anda karena API terus berkembang dari waktu ke waktu.

  1. Gunakan pintasan keyboard Ctrl+Shift+P untuk membuka Palet Perintah. Ketik Azure API Center: Daftarkan API dan tekan Enter.
  2. Pilih CI/CD.
  3. Pilih GitHub atau Azure DevOps, tergantung pada mekanisme kontrol sumber pilihan Anda. Ruang kerja Visual Studio Code harus terbuka untuk ekstensi Azure API Center untuk menambahkan alur ke ruang kerja Anda. Setelah file ditambahkan, selesaikan langkah-langkah yang didokumenkan dalam file alur CI/CD itu sendiri untuk mengonfigurasi variabel dan identitas lingkungan yang diperlukan. Saat melakukan push ke kontrol versi, API terdaftar di pusat API Anda.

Untuk mempelajari selengkapnya tentang menyiapkan alur kerja GitHub Actions, lihat Mendaftarkan API di pusat API Anda menggunakan GitHub Actions.

Hasilkan spesifikasi OpenAPI dari kode API

Gunakan kekuatan GitHub Copilot dengan ekstensi Azure API Center untuk Visual Studio Code untuk membuat file spesifikasi OpenAPI dari kode API Anda. Klik kanan pada kode API, pilih Copilot dari opsi, dan pilih Buat dokumentasi API. GitHub Copilot membuat file spesifikasi OpenAPI.

Animasi memperlihatkan cara menggunakan GitHub Copilot untuk menghasilkan spesifikasi OpenAPI dari kode.

Anda juga dapat membuat spesifikasi OpenAPI dari semua file dalam proyek Anda saat ini. Gunakan Azure API Center: Hasilkan Spesifikasi OpenAPI dari seluruh Proyek dari Palet Perintah.

Setelah membuat file spesifikasi OpenAPI dan memeriksa akurasi, Anda dapat mendaftarkan API dengan pusat API Anda menggunakan perintah Azure API Center: Register API .

Petunjuk / Saran

Pengembang API juga dapat menghasilkan spesifikasi OpenAPI baru menggunakan perintah bahasa alami dengan plugin API Center untuk GitHub Copilot untuk Azure. Untuk mempelajari selengkapnya, lihat Mendesain dan mengembangkan API.

Konten terkait

  • Last updated on