README.zh_CN.md

Alibaba Cloud API Toolkit

Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具，支持在 VS Code 中快速查阅阿里云产品的 API.

简体中文 | English

功能

• 阿里云产品订阅： 插件提供了一键订阅阿里云产品的功能，你可以通过 ctrl+cmd+k 搜索和订阅阿里云产品。

• API 搜索: 你可以通过 ctrl+cmd+l 搜索并查看已订阅的 API 文档。

• API 文档预览: 点击 API 可以打开一个新的标签页，并显示对应的 API 文档，包括描述、请求参数、响应参数和错误码。

• API 调试: 你可以在插件中使用表单的方式调试阿里云 API，并查看结果。

• SDK 代码示例: 你可以在插件中获得 SDK 代码示例，并在编辑器中快速打开对应的 SDK 代码。

• Code Snippets: 支持代码片段功能，帮助你快速编写 SDK 代码。

• profiles 管理: 管理你的阿里云 profiles。

• 文档增强: 插件提供了文档增强功能，你可以在编写 SDK 代码时，通过 hover 代码看到 OpenAPI 的描述信息以及更多相关示例链接，来获得更多代码示例参考, 或直接打开文档进行查阅。

• 敏感信息检测: 插件提供了敏感信息检测功能，在代码编写过程中，插件会自动检测 AK 信息，并提示你用更安全的方式使用 AK。

• 快速搜索文档中的内容: 你可以通过 ctrl+f或cmd+f 快速搜索文档中的内容。

• 设置扩展的语言: 扩展默认为中文，同时支持英文版，通过修改扩展的配置，你可以轻松切换扩展的语言，或跟随系统语言自动切换。

• 更多功能正在开发中，敬请期待...

插件 UI 导览

产品搜索 ctrl+cmd+k

API 搜索 ctrl+cmd+l

API 调试

注意，调试功能需要配置你的 AK 凭证，点击左侧身份图标，可以新增和切换当前的 AK 凭证配置。

SDK 示例

你能够通过调试表单生成 SDK 代码示例，并在编辑器中打开对应的 SDK 代码。

Code Snippets

你能通过代码片段快速生成 SDK 代码示例。

在编辑器输入你已订阅的 API 即可搜索到对应 API 的代码段。

或者你也可以通过快捷键 ctrl+cmd+l 搜索 API，然后选择插入代码段。

Profiles 管理

新增和切换你的阿里云 profiles。

文档增强

你能够在编写 SDK 代码时，通过代码文档看到 OpenAPI 的描述信息以及更多相关示例链接，来获得更多代码示例参考。

敏感信息检测

快速搜索文档中的内容

你可以通过 ctrl+f 或 cmd+f 快速搜索文档中的内容。

设置扩展的语言

点击设置图标，可以快速打开扩展配置，在这里你可以切换扩展的语言。

反馈

• 欢迎在我们的 Github repository 上提交你的问题和建议。
• 您对插件的使用体验满意吗？点击 体验问卷 进行吐槽或夸赞，您的反馈对我们十分重要！

Requirements

• Need VS Code 1.75.0 or above.

License

See the Apache License 2.0.