Trabajar con API Gateway mediante el AWS Toolkit - AWS Cloud9
Invocación de API REST

AWS Cloud9 ya no está disponible para los nuevos clientes. Los clientes existentes de AWS Cloud9 pueden seguir utilizando el servicio con normalidad. Más información

Trabajar con API Gateway mediante el AWS Toolkit

Puede usar API Gateway para crear API de RESTful y API de WebSocket que habilitan aplicaciones de comunicación bidireccional en tiempo real. Para obtener más información sobre cómo crear y administrar API con API Gateway, consulte la Guía para desarrolladores de API Gateway.

Con AWS Toolkit, puede configurar una llamada a una API REST especificando el recurso de REST, el tipo de método y los datos que se pasan como entrada.

Invocación de API REST en API Gateway

importante

Llamar a métodos API con el kit de herramientas de AWS puede provocar cambios en los recursos que no se podrán deshacer. Por ejemplo, si llama a un método POST, los recursos de la API se actualizan si la llamada se lleva a cabo correctamente.

Puede invocar una instancia de API Gateway en AWS desde AWS Toolkit.

Para invocar una API REST

  1. En la ventana del Explorador de AWS, elija el nodo de API Gateway para ver la lista de API de REST disponibles en la Región de AWS actual.

  2. Haga clic con el botón derecho en una API de REST y elija Invoke on AWS (Invocar en AWS).

    nota

    Puede usar el menú contextual para copiar la URL, el nombre y el nombre de recurso de Amazon (ARN) de la API de REST.

    Se muestra la ventana Invoke methods (Invocar métodos). Puede configurar la llamada a la API.

  3. En Select a resource (Seleccionar un recurso), elija el recurso de REST con el que desea interactuar.

  4. En Select a method (Seleccionar un método), elija uno de los siguientes tipos de método:

    • GET: permite obtener un recurso del servicio backend al que se accede a través de la API.

    • OPTIONS: solicita información sobre los métodos y las operaciones que admite API Gateway.

    • GET: crea un recurso en el servicio backend al que se accede a través de la API.

  5. Para participar en la llamada al método de API, puede usar una cadena de consulta o una carga útil con formato JSON:

    • Query string (Cadena de consulta): ingrese una cadena de consulta con el formato parameter1=value1&parameter2=value2. (Antes de usar cadenas de consulta, cree una plantilla de mapeo para transformar las solicitudes web entrantes antes de que se envíen al backend de integración).

    • Formato JSON: puede definir una carga útil con formato JSON en el campo de texto grande en la ventana Invoke methods (Métodos de invocación).

      Por ejemplo, puede agregar un nuevo recurso con un método POST que contenga la siguiente carga útil:

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

  6. Elija el botón Invoke (Invocar) para llamar al recurso de la API REST.

    La respuesta de la API de REST se muestra en la pestaña AWS Remote Invocations (Invocaciones remotas de AWS). El cuerpo de la respuesta contiene los datos del recurso con formato JSON.