Creación de un punto de conexión REST del producto en API Gateway - Amazon API Gateway
Creación de un punto de conexión REST del producto

Creación de un punto de conexión REST del producto en API Gateway

Un punto de conexión REST de un producto es un punto de acceso al producto del portal. Cada punto de conexión consta de la ruta y el método de una API de REST y de la fase en la que se implementa. El punto de conexión incluye toda la documentación que haya definido para la API de REST o se puede actualizar con documentación personalizada. Al crear el punto de conexión REST del producto, se configuran los siguientes ajustes:

  • El nombre de la operación del punto de conexión REST del producto. Si la API de REST tiene la ruta y el método GET /pets, en un portal, el nombre es /pets. Con el nombre de la operación, puede cambiar el nombre del punto de conexión REST del producto a Pet summaries. Esto no afectará a la API existente.

  • La función de prueba para el punto de conexión del producto. Esto permite a los consumidores de API probar las API en el portal. Si crea un punto de conexión de producto para una API privada, la función de prueba se establece en UNAVAILABLE. Para obtener más información, consulte Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal.

  • Si actualmente tienes partes de documentación definidas para la API de REST, puede importar la documentación o invalidar la documentación existente y crear nueva documentación por producto mediante GitHub Flavored Markdown. Las invalidaciones de documentación no se propagan a las partes de la documentación de la API de API Gateway. Si importa las partes de la documentación actual, API Gateway sincroniza los cambios en la API con el punto de conexión REST del producto.

Creación de un punto de conexión REST del producto

En el siguiente procedimiento, se muestra cómo agregar un punto de conexión REST de producto a un producto existente del portal. Para obtener información sobre cómo crear un producto de portal y un punto de conexión REST de producto juntos, consulte Creación de un producto del portal en API Gateway.

Creación de un punto de conexión REST de un producto para un portal de productos

  1. Inicie sesión en la consola de API Gateway, en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación principal, elija Productos de portales.

  3. Elija un producto del portal.

  4. Elija la pestaña Puntos de conexión asociados y, a continuación, elija Agregar puntos de conexión.

  5. Para seleccionar los puntos de conexión REST del producto, en los puntos de conexión de la API, elija una API y, a continuación, elija una etapa.

  6. Para agregar un punto de conexión a los puntos de conexión REST del producto, seleccione el punto de conexión de la API y, a continuación, elija Agregar al producto.

    El punto de conexión de la API aparecerá en la lista de puntos de conexión de la API seleccionados.

  7. Elija Enviar.

  8. La página de punto de conexión REST del producto es ahora un borrador. Elija Borradores de páginas de referencia de la API y, a continuación, elija la página de punto de conexión REST del producto para finalizar el contenido de la página.

  9. Elija Editar página.

  10. Para invalidar la documentación existente de API Gateway, en Origen de documentación, active Invalidar la documentación y haga lo siguiente:

    1. Para Mostrar contenido, elija Crear invalidación.

    2. Para Nombre de operación, ingrese un nombre de operación nuevo.

    3. Para Cuerpo de página, ingrese la documentación personalizada.

    4. (Opcional) Para Punto de conexión, ingrese un punto de conexión personalizado que aparezca en el portal.

  11. Para permitir que los clientes invoquen la API en el portal, seleccione la funcionalidad de la prueba. Para obtener más información, consulte Habilitación de una prueba para un punto de conexión REST de un producto de API Gateway en el portal.

  12. Para Nombre de sección, ingrese un nombre o elija una sección existente. Al agregar el punto de conexión REST del producto a una sección, los consumidores pueden ver el contenido en un portal publicado.

  13. Seleccione Save changes (Guardar cambios).

Para que los consumidores puedan ver la nueva página, igual tendrá que volver a publicar el portal. Para obtener más información, consulte Publicación de un portal en API Gateway.