备案控制台
文档
产品文档
输入文档关键字查找
首页 OpenAPI Explorer 操作指南 IDE 插件 在 Visual Studio Code 中使用 Alibaba Cloud API Toolkit 插件

在 Visual Studio Code 中使用 Alibaba Cloud API Toolkit 插件

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

本文为您介绍在 Visual Studio Code（VS Code）中 Alibaba Cloud API Toolkit 插件的安装和使用。

安装插件

前提条件

安装 VS Code 。

本文为您介绍插件的两种安装方式：

方式一：在插件市场下载安装

  1. 在 VS Code 编辑器左侧（Activity Bar）导航栏中，单击image图标。

  2. 搜索 Alibaba Cloud API Toolkit ，单击安装。

image

方式二：通过浏览器下载安装包

  1. 通过浏览器访问官方Marketplace，单击Install，此时会自动弹出 VS Code 并跳转至扩展页面。

  2. 在VS Code的扩展页面，单击安装。

image

验证安装结果

安装完成后，会在左侧（Activity Bar）导航栏显示阿里云的插件图标，即安装成功。image

用户身份和凭证配置

身份和凭证配置是调用 API 的前提，目前该插件仅支持配置AccessKey（简称AK）凭证。您可以通过以下方式进行配置。

添加或修改身份与凭证配置

  1. 安装 Alibaba Cloud CLI Tools 插件。

    1. 通过浏览器访问 Alibaba Cloud CLI Tools ，单击Install。

    2. 在弹出的对话框，单击打开。

    3. 在VS Code的扩展页面，单击安装。

    4. 安装完成后，会在状态栏显示阿里云的插件图标。

    说明

    您还可以直接在VS Code中安装阿里云CLI。具体操作，请参见使用阿里云CLI Visual Studio Code 插件。

  2. 配置身份凭证。

    1. 在 VS Code 编辑器的顶部菜单栏，选择终端 > 新建终端。

    2. 在终端执行aliyun configure命令，按照提示进行配置。关于 AccessKey 的详细信息，请参见获取AccessKey信息。

    3. 命令逐行回车，出现 Saving profile[xxx] ...Done. 代表该 Profile 保存成功。如果出现 !!! Configure Failed please configure again !!! ，是因为参数格式、参数值范围填写不正确等因素导致的校验失败，但不会阻碍本地保存成功。

      $ aliyun configure
Configuring profile 'default' ...
Aliyun Access Key ID [None]: <Your AccessKey ID>
Aliyun Access Key Secret [None]: <Your AccessKey Secret>
Default Region Id [None]: cn-hangzhou
Default output format [json]: json
Default Language [zh]: zh
      重要

      由于阿里云账号（主账号）拥有资源的所有权限，其 AK 一旦泄露风险巨大，强烈不建议使用阿里云账号 AK 。

查看与切换用户身份

  1. 在左下角的状态栏中，单击阿里云的图标。可在顶部搜索框下查看到已配置成功的用户。

  2. 单击 Profile 名称，即可切换用户身份。

image

功能介绍

Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具，支持在 VS Code 中快速查阅阿里云产品的API，并提供 API 调试、生成和插入 SDK 示例代码等功能。31.png

阿里云产品订阅

该插件提供了一键订阅阿里云产品的功能，支持选择产品不同版本 API，并给予推荐版本提示，无需配置文件，可以通过快捷键ctrl+cmd+k搜索和订阅阿里云产品。image

API 搜索

该插件支持搜索已订阅的 API，也可以通过快捷键ctrl+cmd+l搜索并查看已订阅的 API 文档或插入代码段。

1.png

API 文档预览

点击 API 可以打开一个新的标签页，并显示对应的 API 文档，文档包括接口说明、请求参数、响应参数和错误码。3.png

API 调试

  • 通过身份凭证验证后，该插件可支持 API 调试。

  • 支持参数表单填写的方式调试阿里云 API，并查看结果。

  • 调用返回结果可以直接在编辑器中快速打开。

API调试.png

SDK 代码示例的查看与插入

查看代码示例

该插件支持生成SDK示例代码。可通过参数表单填写的方式获得不同语言的 SDK 代码示例，并支持在编辑器中快速打开对应的 SDK 代码或另存为新文件。4.png

插入代码片段（Code Snippets）

该插件目前支持一键插入 Java 和 Java 异步 SDK 示例代码片段，快速生成 SDK 代码示例。

  • 方式一：在编辑器中输入您已订阅的 API，即可搜索到对应 API 的代码段。1708501426400-2f7b6ccc-0f8b-4d4e-bf7f-06fe9c9720e4.gif

  • 方式二：通过快捷键ctrl+cmd+l搜索 API，选择插入代码段。2.gif

问题反馈

如果您在使用中遇到任何问题，可以通过在Github repository上提交反馈，帮助我们共同改进在 VS Code中使用 Alibaba Cloud API Toolkit 插件体验。

文档推荐
  • 本页导读 （1）
文档反馈