OpenAPI Explorer：Gunakan Alibaba Cloud API Toolkit di VS Code

Prasyarat

VS Code telah terinstal.

Metode 1: Unduh dan instal ekstensi dari Extensions

1. Di bilah navigasi sisi kiri VS Code, klik ikon .

2. Cari Alibaba Cloud API Toolkit dan klik Install.

Metode 2: Unduh paket instalasi dari browser

1. Kunjungi halaman Alibaba Cloud API Toolkit di Marketplace resmi VS Code melalui browser. Klik Install. Klien VS Code akan dipanggil dan halaman Alibaba Cloud API Toolkit muncul.

2. Di halaman Alibaba Cloud API Toolkit di VS Code, klik Install.

Verifikasi instalasi

Setelah ekstensi terinstal, ikon Alibaba Cloud akan muncul di panel navigasi sisi kiri.

Berlangganan layanan Alibaba Cloud

Alibaba Cloud API Toolkit memungkinkan Anda berlangganan layanan Alibaba Cloud hanya dengan beberapa klik, mendukung versi API berbeda dari layanan Alibaba Cloud, dan memberikan rekomendasi versi yang direkomendasikan. Anda dapat menekan Ctrl+Cmd+K (Ctrl+Win+K di Windows) untuk mencari dan berlangganan layanan Alibaba Cloud tanpa perlu menggunakan file konfigurasi.

Pencarian API

Alibaba Cloud API Toolkit memungkinkan Anda mencari API yang telah Anda langgani. Anda dapat menekan Ctrl+Cmd+L (Ctrl+Win+L di Windows) untuk mencari dan melihat referensi API yang sesuai dengan API yang dilanggan. Anda juga dapat menyisipkan potongan kode.

Pratinjau referensi API

Anda dapat mengklik operasi API untuk membuka tab baru dan melihat referensi API yang sesuai di tab tersebut. Referensi API berisi informasi seperti catatan penggunaan, parameter permintaan, parameter respons, dan kode kesalahan.

Debugging API

• Setelah identitas dan kredensial diverifikasi, Anda dapat menggunakan Alibaba Cloud API Toolkit untuk men-debug operasi API.

• Anda dapat men-debug API Alibaba Cloud dengan mengonfigurasi parameter dan melihat hasil debugging.

• Anda dapat langsung melihat hasil yang dikembalikan dari operasi API di VS Code.

Gunakan kode contoh

Lengkapi dan jalankan kode

• Lengkapi kode

  • Modifikasi titik akhir.

    Masuk ke OpenAPI Explorer, arahkan pointer ke Cloud Products di bilah navigasi atas, lalu klik layanan Alibaba Cloud. Di tab Regions pada halaman yang muncul, Anda dapat melihat titik akhir yang didukung.

  • Tentukan parameter permintaan. Untuk informasi lebih lanjut, lihat bagian Pratinjau referensi API dari topik ini.

  • Opsional. Tambahkan logging.

  • Simpan kode.

    import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
    import Ecs20140526, * as $Ecs20140526 from '@alicloud/ecs20140526';
    export default class DescribeRegion {
        static async main(args: string[]): Promise<void> {
            let config = new $OpenApi.Config({
                // Pastikan variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET dikonfigurasi di lingkungan runtime kode.
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Tentukan titik akhir. Untuk informasi lebih lanjut, lihat titik akhir di https://api.aliyun.com/product/Ecs.
                endpoint: `ecs.cn-hangzhou.aliyuncs.com`,
            });
            let client = new Ecs20140526(config);
            let describeRegionsRequest = new $Ecs20140526.DescribeRegionsRequest({});
            let response = await client.describeRegions(describeRegionsRequest);
            console.log(response.body?.regions?.region);
        }
    }

• Jalankan kode

  1. Jalankan perintah berikut di terminal untuk mengompilasi file TypeScript menjadi file JavaScript:

     tsc client.ts # client.ts adalah nama file.

  2. Buat file main.js dan salin kode berikut di bagian edit:

     const { default: Describeregion } = require("./describeregion");
     
     Describeregion.main();
     

  3. Jalankan perintah berikut di terminal untuk menjalankan kode contoh:

     node .\main.js

  4. Lihat hasilnya. Jika hasil yang ditampilkan pada gambar berikut dikembalikan, pemanggilan berhasil.