OpenAPI Explorer：在Visual Studio Code中使用Alibaba Cloud API Toolkit外掛程式

前提條件

安裝VS Code。

方式一：在外掛程式市場下載安裝

1. 在VS Code編輯器左側（Activity Bar）導覽列中，單擊表徵圖。

2. 搜尋Alibaba Cloud API Toolkit ，單擊安裝。

方式二：通過瀏覽器下載安裝包

1. 通過瀏覽器訪問官方Marketplace，單擊Install，此時會自動彈出VS Code並跳轉至擴充頁面。

2. 在VS Code的擴充頁面，單擊安裝。

驗證安裝結果

安裝完成後，會在左側（Activity Bar）導覽列顯示阿里雲的外掛程式表徵圖，即表示安裝成功。

阿里雲產品訂閱

該外掛程式提供了一鍵訂閱阿里雲產品的功能，支援選擇產品不同版本API，並給予推薦版本提示，無需設定檔，可以通過快速鍵Ctrl+cmd+K（Windows系統中對應的快速鍵是Ctrl+win+K）搜尋和訂閱阿里雲產品。

API 搜尋

該外掛程式支援搜尋已訂閱的API，也可以通過快速鍵Ctrl+cmd+L（Windows系統中對應的快速鍵是Ctrl+win+L）搜尋並查看已訂閱的API文檔或插入程式碼片段。

API文檔預覽

點擊API可以開啟一個新的標籤頁，並顯示對應的API文檔，文檔包括介面說明、請求參數、響應參數和錯誤碼。

API調試

• 通過身份憑證驗證後，該外掛程式可支援API調試。

• 支援參數表單填寫的方式調試阿里雲API，並查看結果。

• 調用返回結果可以直接在編輯器中快速開啟。

使用外掛程式提供的程式碼範例

補全並運行代碼

• 補全代碼。

  • 修改endpoint。

    登入OpenAPI 門戶，然後選擇雲產品，在雲產品首頁可查看支援的服務存取點。

  • 添加請求參數。請求參數請查看API文檔預覽。

  • （可選）添加日誌。

  • 儲存修改內容。

    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({
                // 請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Endpoint 請參考 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);
        }
    }

• 運行代碼

  1. 在終端執行以下命令，將TypeScript編譯成JavaScript檔案。

     tsc client.ts # client.ts為檔案名稱

  2. 建立一個main.js檔案，在編輯地區複製以下代碼。

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

  3. 在終端（TERMINAL）執行以下命令，運行範例程式碼。

     node .\main.js

  4. 運行結果，如果返回結果如下所示，則表示調用成功。