Alibaba Cloud Developer Toolkit JetBrains plugin-OpenAPI Explorer(OpenAPI)-阿里云帮助中心

Install the plugin

Prerequisites

A JetBrains IDE, such as IntelliJ IDEA, PyCharm, or GoLand, is installed.
The IDE version must be 2022.2 or later.

The following examples use IntelliJ IDEA for Windows.

Method 1: Install from the marketplace

In the IntelliJ IDEA top menu bar, choose > Plugins…, or choose File > > Plugins.
On the Plugins page, click the Marketplace tab.
Search for Alibaba Cloud Developer Toolkit and click Install.
Click Apply, and then click OK.

Method 2: Install from a downloaded package

Download the plugin package from the JetBrains Marketplace.
In the IntelliJ IDEA top menu bar, choose > Plugins…, or choose File > > Plugins.
On the Plugins page, click the gear icon , select Install Plugin from Disk..., and then select the downloaded package. Do not decompress the package.

Verify the installation

After installation, the Toolkit icon appears in the left-hand tool window bar.

Configure a profile

Configure a profile with valid AccessKey credentials to make API calls. The plugin supports only AccessKey credentials.

Note

If you do not have Alibaba Cloud CLI installed, you must use Method 1 to configure your profile.
If you have Alibaba Cloud CLI installed, you can use either Method 1 or Method 2 to configure your profile.

Method 1

Click New Profile or the icon.
Enter the Profile Name, RegionId, Access Key ID, and Secret Access Key. Use an existing AccessKey pair or create one. View the AccessKey information of a RAM user. The Secret Access Key is displayed only once — store it securely.

Important
A root account AccessKey grants full permissions to all resources and poses a significant security risk if compromised. We recommend using a RAM user AccessKey instead.
Click Add Configurations.
A Profile added. message appears. Select the new profile from the drop-down list in the left pane.
Click a profile name to switch the active profile.

Method 2

If Alibaba Cloud CLI is installed and configured, the plugin reuses its credential configuration. Configure credentials for Alibaba Cloud CLI.
Use the drop-down list in the left pane or the status bar to switch between profiles.
Click a profile name in the drop-down list to activate it.

Features

The plugin lets you browse Alibaba Cloud APIs, debug API calls, generate SDKs, and insert SDK sample code in your projects.

Search for services and APIs

The left pane lists services in a tree view. Search by service name in English or Chinese, then click a service to browse its APIs.

View API reference

Click an API to view its reference, including description, request parameters, response parameters, and error codes.

API debugging

API debugging requires authentication.
Fill in the API parameters to view results in the IDE, or click Debug to open the API in OpenAPI Explorer.

View and insert SDK sample code

View SDK sample code

The plugin can generate SDK sample code.

The plugin generates sample code based on your parameters. Open and edit the code directly in the IDE.
Automatic dependency import is supported for Maven only.
Use the Installation Method and View Source Code buttons to manage dependencies and view source code.

Insert code snippets

Insert Java or async Java SDK sample code with a single click. The plugin adds the Maven dependency to your pom.xml automatically. Toggle this feature by right-clicking and selecting Alibaba Cloud Developer Toolkit > Disable/Enable Alibaba Cloud SDK auto-completion, or press ctrl+cmd+p.