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. 运行结果，如果返回结果如下所示，则表示调用成功。