Publicación de una API
Escenario
Las API solo se pueden llamar después de que se hayan publicado en un entorno. Puedes publicar APIs en diferentes entornos. API Gateway le permite ver el historial de publicaciones (como la versión, la descripción, la hora y el entorno) de cada API, y admite la reversión de las API a diferentes versiones históricas.
- Si modifica una API publicada, debe publicarla de nuevo para que las modificaciones surtan efecto en el entorno en el que se ha publicado la API.
- Un máximo de 10 registros de publicación de una API se conservan en un entorno.
Prerrequisitos
- Ha creado un grupo de API y una API.
- Usted ha creado un entorno.
Publicación de una API
- Inicie sesión en la consola de gestión.
- Haga clic en
en la esquina superior izquierda y seleccione una región. - Haz clic en
en la esquina superior izquierda y elige API Gateway. - Elija un tipo de puerta de enlace en el panel de navegación.
- Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
- Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.
- En el panel de navegación, elija API Publishing > APIs.
- Publicar una API. Puede utilizar uno de los métodos siguientes:
- Haga clic en Publish en la fila que contiene la API que deseas publicar.
- Haz clic en el nombre de la API de destino y haz clic en Publish en la esquina superior derecha de la página de detalles de la API mostrada.
Para publicar varias API, seleccione las API y haga clic en Publish. Puede publicar un máximo de 1000 API a la vez.
- Seleccione el entorno donde se publicará la API e introduzca una descripción.
Figura 1 Publicación de una API
- Si la API ya se ha publicado en el entorno, publicarla de nuevo sobrescribirá su definición en ese entorno.
- Si no hay ningún entorno que cumpla con sus requisitos, cree uno nuevo.
- Haga clic en Publish.
Consulta del historial de publicaciones
- Inicie sesión en la consola de gestión.
- Haga clic en en la esquina superior izquierda y seleccione una región.
- Haz clic en
en la esquina superior izquierda y elige API Gateway. - Elija un tipo de puerta de enlace en el panel de navegación.
Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.
- En el panel de navegación, elija API Publishing > APIs.
- Haga clic en el nombre de la API de destino.
- Haga clic en la pestaña Publication History.
Se muestra el historial de publicaciones de la API.
Figura 2 Consulta del historial de publicaciones
- Haga clic en View Details en la columna Operation de una versión.
El cuadro de diálogo View Details muestra la información básica, la información de solicitud de front-end y back-end, los parámetros de entrada y constantes, las asignaciones de parámetros y las respuestas de ejemplo de la API.
- Para revertir la API a una versión histórica, haga clic en Switch Version en la fila que contiene la versión de destino y haga clic en Yes.
Si se muestra "current version" junto a la versión de destino, la reversión se realizó correctamente.
Cuando se llama a la API, se utiliza la configuración de la versión actual en lugar de la configuración guardada anteriormente.
Por ejemplo, se publicó una API en el entorno RELEASE el 1 de agosto de 2018. El 20 de agosto de 2018, la API se publicó en el mismo entorno después de la modificación. Si la versión publicada el 1 de agosto se establece como la versión actual, la configuración de esta versión se utilizará cuando se llame a la API.
Publicación de una API llamando a una API
También puede publicar una API llamando a una API proporcionada por API Gateway. Para obtener más información, consulte la siguiente referencia:
