OpenAPI Explorer:Plugin Alibaba Cloud Developer Toolkit para JetBrains IDEs

Pré-requisitos

• Uma JetBrains IDE instalada, como IntelliJ IDEA, PyCharm ou GoLand.

• Versão da IDE 2022.2 ou superior.

Método 1: Instalação pelo marketplace

1. Na barra de menu superior do IntelliJ IDEA, selecione > Plugins… ou acesse File > > Plugins.

2. Na página Plugins, clique em Marketplace.

3. Pesquise por Alibaba Cloud Developer Toolkit e clique em Install.

4. Clique em Apply e, em seguida, em OK.

Método 2: Instalação a partir de um pacote baixado

1. Baixe o pacote do plugin no JetBrains Marketplace.

2. Na barra de menu superior do IntelliJ IDEA, selecione > Plugins… ou acesse File > > Plugins.

3. Na página Plugins, clique em , selecione Install Plugin from Disk... e escolha o pacote baixado. Não descompacte o arquivo.

Verificar a instalação

Após a instalação, a árvore Alibaba Cloud API aparece na barra lateral de ferramentas à esquerda do IntelliJ IDEA e lista categorias de service como Application Security, Big Data, Application Services, cloud Communication, Networking, Storage and CDN, Video Services e Artificial Intelligence. A mensagem Alibaba Cloud: é exibida no lado direito da barra de status na parte inferior, indicando que o plugin Alibaba Cloud Developer Toolkit está pronto para uso.

Método 1

1. Na barra de ferramentas superior do IntelliJ IDEA, clique em para abrir o painel Alibaba Cloud Developer Tools e selecione New Profile na lista suspensa no topo do painel esquerdo para criar um perfil. Alternativamente, clique em .

2. Insira o Profile Name, RegionId, Access Key ID e Secret Access Key. Use um par de AccessKey existente ou crie um novo. View the AccessKey information of a RAM user. O Secret Access Key é exibido apenas uma vez — armazene-o com segurança.

   Importante

   Um AccessKey de conta raiz concede permissões totais a todos os recursos e representa um risco significativo de segurança se for comprometido. Recomendamos o uso de um AccessKey de usuário RAM.

3. Clique em Add Configurations.

4. A mensagem Profile added. será exibida. Selecione o novo perfil na lista suspensa do painel esquerdo.

5. Clique em switch the active profile.

Método 2

1. Se o Alibaba Cloud CLI estiver instalado e configurado, o plugin reutilizará sua configuração de credenciais. Configure credentials for Alibaba Cloud CLI.

2. Use a lista suspensa no painel esquerdo ou na barra de status para alternar entre perfis.

3. Clique em nome de um perfil na lista suspensa para ativá-lo.

Pesquisar services e APIs

O painel esquerdo exibe os services em uma visualização de árvore. Pesquise pelo nome do service em inglês ou chinês e clique em para navegar por suas APIs.

No painel esquerdo do plugin Alibaba Cloud Developer Toolkit, use o seletor Profile para alternar a configuração da conta, insira uma palavra-chave do service, como ecs, na caixa de pesquisa e selecione o service desejado, como Elastic Compute Service (ECS), na árvore de services. Após selecionar um service, o painel direito exibe a lista de APIs correspondente. É possível pesquisar APIs por palavra-chave — por exemplo, ao digitar run, os resultados incluem RunInstances e RunCommand. O catálogo completo de APIs é exibido abaixo, agrupado por categoria de recurso, como Resource Assurance, Block Storage, Images, Security Groups e cloud Assistant.

Visualize referência da API

Clique em uma API para visualizar sua referência, incluindo descrição, parâmetros de solicitação, parâmetros de resposta e códigos de erro.

No painel de navegação de APIs à esquerda do plugin Alibaba Cloud Developer Toolkit, pesquise e selecione o service desejado, como Elastic Compute Service (ECS). A página da API correspondente, como DescribeRegions, abre no painel direito. A página oferece três abas: API reference, Sample Code e Debug. Na aba API reference, visualize os parâmetros de solicitação da API, incluindo nomes, tipos e valores válidos dos parâmetros. Selecione um endpoint na lista suspensa na parte inferior da página ou clique em Debug no canto superior direito para iniciar a depuração da API.

Depuração de API

• A depuração de API requer autenticação.

• Preencha os parâmetros da API para visualizar os resultados na IDE ou clique em Debug para abrir a API no OpenAPI Explorer.

Na caixa de pesquisa da árvore de navegação à esquerda, insira uma palavra-chave como ecs e selecione o service desejado, como Elastic Compute Service (ECS). O painel direito exibe os detalhes da API selecionada em três abas: API reference, Sample Code e Debug. Preencha os parâmetros de solicitação no formulário, como RegionId, ImageId e InstanceType, selecione um endpoint e clique em Debug na parte inferior para iniciar a depuração na IDE. Também é possível clicar em Clear Parameters ou Generate Sample para auxiliar na operação.

Visualize código de exemplo do SDK

O plugin gera códigos de exemplo SDKSDK.

• O código de exemplo é gerado com base nos seus parâmetros. Abra e edite o código diretamente na IDE.

• A importação automática de dependências tem suporte apenas para Maven.

• Use os botões Installation Method e View Source Code para gerencie dependências e visualize o código-fonte.

Selecione uma linguagem, como Java, no painel do plugin e clique em Generate Sample. O plugin gera o código de exemplo do SDK para RunInstances e o importa para o editor. O código de exemplo gerado é o seguinte:

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with an AccessKey pair
     * @param accessKeyId
     * @param accessKeySecret
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.ecs20140526.Client createClient() throws xxx {
        // Leaked project code may expose your AccessKey pair and threaten all resources under the account xxx
        // We recommend the more secure STS method. For more authentication methods, see: https://hexxx
        com.aliyun.teaopenapi.models.Config config = new com.aliyuxxx
        // Required. Make sure that the ALIBABA_CLOUD_xxx environment variable is set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUDxxx
        // Required. Make sure that the ALIBABA_CLOUD_Axxx environment variable is set in the code runtime environment
            .setAccessKeySecret(System.getenv("ALIBABA_Cxxx
        // For the endpoint, see https://api.alibabacloud.com/product/Ecs
        config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
        return new com.aliyun.ecs20140526.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_xxx
        com.aliyun.ecs20140526.Client client = Sample.createClientxxx
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstaxxx

Insira trechos de código

Insira códigos de exemplo do SDK Java ou Java assíncrono com um único clique. O plugin adiciona a dependência Maven ao seu pom.xml automaticamente. Ative ou desative esse recurso clicando com o botão direito e selecionando Alibaba Cloud Developer Toolkit > Disable/Enable Alibaba Cloud SDK auto-completion, ou pressione ctrl+cmd+p.

public class Test1 {
    public static void main(String[] args) {
        run

Ao digitar run no editor, o plugin exibe uma lista de conclusão de código com sugestões de APIs da Alibaba Cloud, como RunInstances::Ecs::2014-05-26 (cria instâncias ECS) e RunCommand::cloudphone::2020-12-30 (execute um comando em um cloud phone).

Pesquise por ecs no painel do Alibaba Cloud Developer Toolkit, expanda a categoria Elastic Computing e selecione Elastic Compute Service (ECS). O editor gera automaticamente o seguinte código SDK. Uma caixa de diálogo aparece no canto inferior direito perguntando se deseja importar automaticamente a dependência ecs20140526. Clique em Yes para importá-la.

public class Test1 {
    public static void main(String[] args) {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
            .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
            // For the endpoint, see https://api.alibabacloud.com/product/Ecs
            .setEndpoint("ecs.cn-qingdao.aliyuncs.com");
        com.aliyun.ecs20140526.Client client = new com.aliyun.ecs20140526.Client(config);
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstancesRequest = new com.aliyun.ecs20140526.models.RunInstancesRequest();
        com.aliyun.ecs20140526.models.RunInstancesResponse runInstancesResponse = client.runInstances(runInstancesRequest);
    }
}

public class Test1 {
    public static void main(String[] args) throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
            .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
            // For the endpoint, see https://api.alibabacloud.com/product/Ecs
            .setEndpoint("ecs.cn-qingdao.aliyuncs.com");
        com.aliyun.ecs20140526.Client client = new com.aliyun.ecs20140526.Client(config);
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstancesRequest = new com.aliyun.ecs20140526.models.RunInstancesRequest();
        com.aliyun.ecs20140526.models.RunInstancesResponse runInstancesResponse = client.runInstances(runInstancesRequest);
    }
}