Como trabalhar com o API Gateway usando o kit de ferramentas da AWS - AWS Cloud9
Invocar uma API REST

O AWS Cloud9 não está mais disponível para novos clientes. Os clientes atuais do AWS Cloud9 podem continuar usando o serviço normalmente. Saiba mais

Como trabalhar com o API Gateway usando o kit de ferramentas da AWS

Você pode usar o API Gateway para criar APIs RESTful e APIs de WebSocket que permitem aplicações de comunicação bidirecional em tempo real. Para obter mais informações sobre como criar e gerenciar APIs com o API Gateway, consulte o Guia do desenvolvedor do API Gateway.

Com o AWS Toolkit, você pode configurar uma chamada para uma API REST especificando o recurso REST, o tipo de método e os dados que são passados como entrada.

Invocar APIs REST no API Gateway

Importante

Chamar métodos de API usando o Kit de ferramentas da AWS pode ocasionar alterações em recursos que não podem ser desfeitas. Por exemplo, se você chamar um método POST, os recursos da API serão atualizados se a chamada for bem-sucedida.

Você pode invocar um API Gateway na AWS do AWS Toolkit.

Para invocar uma API REST

  1. Na janela AWS Explorer, selecione o nó do API Gateway para visualizar a lista de APIs REST disponíveis na Região da AWS.

  2. Clique com o botão direito do mouse em uma API REST e selecione Invocar na AWS.

    nota

    É possível usar o menu de contexto permite copiar o URL, o nome e o Nome do recurso da Amazon (ARN) da API REST.

    A janela Invoke methods (Invocar métodos) é exibida. Você pode configurar a chamada para a API.

  3. Em Select a resource (Selecionar um recurso), selecione o recurso REST com o qual deseja interagir.

  4. Em Select a method (Selecionar um método), escolha um dos seguintes tipos de método:

    • GET: Obtém um recurso do serviço de backend que é acessado por meio da API.

    • OPTIONS (Opções): solicita informações sobre os métodos e operações compatíveis com o API Gateway.

    • POST: cria um novo recurso do serviço de backend que é acessado por meio da API.

  5. Para fornecer input para sua chamada do método API, você pode usar uma string de consulta ou carga útil formatada em JSON:

    • Query string (String de consulta): insira uma string de consulta usando o formato: parameter1=value1&parameter2=value2. (Antes de usar as cadeias de caracteres de consulta, crie um modelo de mapeamento para transformar solicitações da Web recebidas, antes que elas sejam enviadas para o back-end de integração).

    • Formato JSON: você pode definir uma carga útil formatada em JSON no campo de texto grande na janela Invoke methods (Métodos de invocação).

      Por exemplo, você pode adicionar um novo recurso com um método POST que contenha a seguinte carga útil:

      {"type": "soda", "price" : 3.99}

  6. Selecione o botão Invoke (Invocar) para chamar o recurso REST API.

    A resposta da API REST é exibida na guia Invocações remotas da AWS. O corpo da resposta contém os dados do recurso formatado em JSON.