Skip to content

๐Ÿš€ The Alibaba Cloud API extension for VS Code. Click the link to install the extension. ๐Ÿ‘‡๐Ÿ‘‡๐Ÿ‘‡

License

Notifications You must be signed in to change notification settings

aliyun/alibabacloud-api-vscode-toolkit

Repository files navigation

Alibaba Cloud API Toolkit

Version Installs Ratings

The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud services.

English | ็ฎ€ไฝ“ไธญๆ–‡

Features

  • Alicloud Product Subscription: You can search for Alicloud products and subscribe to its APIs you want to use.

  • API Searching: You can search the Open API of Alibaba Cloud products to which you are subscribed.

  • API Document View: Clicking on an API can navigate you to a new tab which displays the corresponding API document, including descriptions, request parameters, response parameters and error codes.

  • Call the API: You can use the form to call the Alibaba Cloud API and see the response.

  • SDK Code Sample: You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.

  • Code Snippets: You can use the code snippets to quickly generate the code.

  • Profiles Management: Manage your Alibaba Cloud profiles.

  • Document Enhancement: Extension provides a document enhancement function, you can write SDK code, through the hover code to see the description of OpenAPI information and more related example links, to get more code example reference, or directly open the document for reference.

  • Sensitive Information Linter: Extension provides sensitive information detection, during the code writing process, the extension will automatically detect AK information, and prompt you to use the AK in a more secure way.

  • Quickly Search the Contents of the Document: You can quickly search the contents of the document by using ctrl+f or cmd+f.

  • Set the display language of extension: The extension default language is Chinese, while supporting English, by modifying the extension configuration, you can easily switch the extension language, or follow the system language automatically switch.

  • More features are under development, please stay tuned.

Extension UI Guide

VSCode Extension Guide

Product Searching ctrl+cmd+k

Product Searching

API Searching ctrl+cmd+l

API Serching

Call the API

API debugging

Note that the debugging needs to configure your AK credentials, click the left identity icon, you can add and switch the current AK credentials configuration.

manage profiles

SDK Code Sample

You can generate the SDK Sample by using the debugger form and then open it in your editor.

sdk demo

Code Snippets

You can use the code snippets to quickly generate the code.

Type your subscribed API into the editor and select the API snippet you want to generate.

code snippets Or use the keyboard shortcuts ctrl+cmd+l to search the API and select Insert snippets.

code snippets

Profiles Management

Add and switch your Alibaba Cloud profiles.

Profiles Management

Document Enhancement

When writing SDK code, you can get more code sample references by viewing the OpenAPI description information and additional related sample links through the code documentation.

Document enhancement

Sensitive Information Warning Linter

Sensitive Information Warning Linter

Quickly Search the Contents of the Document

Use ctrl+f or cmd+f to quickly search for the contents of the document.

Set the display language of extension

Tap the Settings icon to quickly open the extension configuration, where you can switch the display language of the extension.

Feedback

Requirements

  • Need VS Code 1.75.0 or above.

License

See the Apache License 2.0.