OpenAPI Explorer:Usar o Alibaba Cloud API Toolkit no VS Code

Pré-requisitos

O VS Code deve estar instalado.

Método 1: Instalação pela visualização de extensões

1. Na barra de atividades do VS Code, clique em .

2. Pesquise por Alibaba Cloud API Toolkit e clique em Install.

Método 2: Instalação pelo VS Code Marketplace

1. Acesse a página do Alibaba Cloud API Toolkit no VS Code Marketplace e clique em Install. O VS Code abrirá a página da extensão.

2. Clique em Install na página da extensão no VS Code.

Verificar a instalação

Após a instalação, o ícone da Alibaba Cloud aparece na barra de atividades.

Na Extensions view da barra lateral do VS Code, pesquise por Alibaba Cloud API Toolkit. O painel principal exibe o nome da extensão, a versão (v0.0.9), o publicador (Alibaba Cloud OpenAPI) e um botão azul Uninstall. Isso confirma que a extensão está instalada corretamente.

Assinar serviços

Assine os serviços da Alibaba Cloud e selecione as versões das APIs. A extensão recomenda versões automaticamente, sem necessidade de arquivo de configuração. Pressione Ctrl+Cmd+K (Ctrl+Win+K no Windows) para pesquisar e assinar.

Na lista suspensa de service de API, use a caixa de pesquisa para filtrar e selecionar o service desejado. Por exemplo, selecione Certificate Management Service (código do service cas, versão recomendada 2020-04-07).

Pesquisa de API

Pesquise APIs assinadas e visualize suas referências. Pressione Ctrl+Cmd+L (Ctrl+Win+L no Windows) para buscar APIs ou inserir trechos de código.

Ao digitar uma palavra-chave como describe na caixa de pesquisa, as operações de API correspondentes aparecem abaixo. Cada entrada mostra o método de requisição, o nome da operação, uma breve descrição e o caminho da versão.

Pré-visualização da referência da API

Clique em para visualizar sua referência em uma nova aba, incluindo notas de uso, parâmetros de requisição, parâmetros de resposta e códigos de erro.

No API Toolkit, o painel esquerdo exibe a árvore de navegação de APIs, permitindo explorar as operações por service e categoria. Ao selecionar uma operação, como RebootInstances — Restarts one or more instances, o painel principal à direita mostra a referência dessa operação, contendo a descrição e os parâmetros de requisição. Use as abas no topo para alternar entre Document, Debug e Code Sample.

Depuração de API

• Depure operações de API após a verificação de credenciais.

• Configure parâmetros e visualize os resultados da depuração.

• Veja as respostas da API diretamente no VS Code.

Por exemplo, selecione a operação DescribeRegions. No formulário de parâmetros, defina Endpoint como China (Hangzhou), InstanceChargeType como PrePaid, ResourceType como instance e AcceptLanguage como zh-CN. Ao clicar em Debug, o painel direito exibirá uma resposta bem-sucedida com código de status HTTP 200 em formato JSON, contendo a lista de regiões disponíveis.

Usar código de exemplo

Completar e executar o código

• Complete o código

  • Modifique o endpoint.

    Faça login no OpenAPI Explorer, passe o mouse sobre Cloud Products e selecione um service. Visualize os endpoints compatíveis na aba Regions.

  • Especifique os parâmetros de requisição. Para mais informações, consulte a seção API reference preview deste tópico.

  • Opcional. Adicione logging.

  • Salve o código.

    import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
    import Ecs20140526, * as $Ecs20140526 from '@alicloud/ecs20140526';
    export default class DescribeRegion {
        static async main(args: string[]): Promise<void> {
            let config = new $OpenApi.Config({
                // Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are configured in the code runtime environment. 
                accessKeyId: process.env['ALIBABA_CLOUD_ACCESS_KEY_ID'],
                accessKeySecret: process.env['ALIBABA_CLOUD_ACCESS_KEY_SECRET'],
                // Specify an endpoint. For more information, see endpoints at https://api.alibabacloud.com/product/Ecs.
                endpoint: `ecs.cn-hangzhou.aliyuncs.com`,
            });
            let client = new Ecs20140526(config);
            let describeRegionsRequest = new $Ecs20140526.DescribeRegionsRequest({});
            let response = await client.describeRegions(describeRegionsRequest);
            console.log(response.body?.regions?.region);
        }
    }

• Execute o código

  1. Compile o arquivo TypeScript para JavaScript:

     tsc client.ts # client.ts is the file name.

  2. Crie um arquivo main.js com o seguinte código:

     const { default: Describeregion } = require("./describeregion");
     
     Describeregion.main();
     

  3. Execute o código de exemplo:

     node .\main.js

  4. Se o resultado abaixo for retornado, a chamada foi bem-sucedida.

     PS D:\ide\tooldemo> tsc describeregion.ts
     PS D:\ide\tooldemo> node .\main.js
     [
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Qingdao)',
         regionEndpoint: 'ecs.cn-qingdao.aliyuncs.com',
         regionId: 'cn-qingdao'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Beijing)',
         regionEndpoint: 'ecs.cn-beijing.aliyuncs.com',
         regionId: 'cn-beijing'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Zhangjiakou)',
         regionEndpoint: 'ecs.cn-zhangjiakou.aliyuncs.com',
         regionId: 'cn-zhangjiakou'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Hohhot)',
         regionEndpoint: 'ecs.cn-huhehaote.aliyuncs.com',
         regionId: 'cn-huhehaote'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Ulanqab)',
         regionEndpoint: 'ecs.cn-wulanchabu.aliyuncs.com',
         regionId: 'cn-wulanchabu'
       },
       DescribeRegionsResponseBodyRegionsRegion {
         localName: 'China (Hangzhou)',
         ...
       }
     ]