Todos los productos
Search

Este producto

    API Gateway:Manage REST APIs

    Centro de documentos

    API Gateway:Manage REST APIs

    Última actualización: Sep 03, 2026

    Publique, importe, exporte y cancele la publicación de API REST en la consola de Cloud-native API Gateway. También puede generar un SDK y su documentación con un solo clic.

    Publicar una API

    Requisitos previos

    Antes de publicar una API, asegúrese de que sus operaciones estén definidas y creadas.

    Procedimiento

    Cloud-native API Gateway admite dos tipos de API: API compartidas y API con ámbito de instancia.

    Shared API

    1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

    2. Haga clic en el nombre de la API deseada. En la esquina superior derecha, haga clic en Publish.

    3. En el panel Publish API, configure los parámetros y haga clic en Publish.

      Parámetro

      Descripción

      Domain Name

      Seleccione un nombre de dominio. La API será accesible a través de este dominio después de la publicación.

      Si no hay ningún nombre de dominio disponible, haga clic en Add Domain Name. Para obtener más información, consulte Create a domain name.

      Instance

      Seleccione una instancia de gateway. Utilice distintas instancias para aislar entornos.

      Scenario

      Los escenarios incluyen versión básica y canary release. Para conocer los tipos de servicio de backend, consulte Routing.

      Escenarios básicos

      • Mock: Devuelve una respuesta simulada basada en la configuración de simulación de la operación. Las operaciones sin configuración de simulación no son accesibles.

        Nota

        Para publicar en el escenario de simulación, al menos una operación debe tener habilitada una configuración de simulación. De lo contrario, la publicación fallará.

      • Single Service: Dirige todas las solicitudes a un único servicio de backend. Es el caso de uso más común.

      Escenarios de canary release

      • By Percentage (Multi-service): Distribuye el tráfico a los servicios de backend por porcentaje. Se utiliza para el cambio de tráfico y las versiones canary.

        Nota

        La suma de los pesos de todos los servicios debe ser 100.

      • By Content (Multi-service): Dirige el tráfico a diferentes servicios de backend según las condiciones de coincidencia. La regla marcada como Default gestiona el tráfico no coincidente.

        • Tipos de coincidencia compatibles: Equal, Prefix y Regex.

        • Ubicaciones de parámetros compatibles: Query y Header.

        Las múltiples condiciones se combinan mediante lógica AND.

        Importante

        Solo se puede establecer una regla como Default. Todas las demás reglas deben tener una condición de coincidencia no vacía.

      • By Tag (Proportion-based Routing): Distribuye el tráfico por porcentaje entre las versiones de múltiples servicios de backend. Para versiones canary de enlace completo, se recomienda el enrutamiento de servicio único.

      Backend Services

      Asocie un servicio de backend en el gateway o VPC. Si no hay ninguno disponible, haga clic en Create Service para Create a service.

      Publish Description

      Introduzca una descripción para esta publicación.

    Instance-scoped API

    1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

    2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

    3. En la esquina superior derecha, haga clic en Publish. En el panel Publish API, configure los parámetros y haga clic en Publish.

      Parámetro

      Descripción

      Instance

      La instancia donde se publica la API. Utilice distintas instancias para aislar entornos.

      VPC

      La VPC donde se encuentra la instancia.

      Publish Scope

      El alcance de las operaciones de la API que se publicarán. Haga clic en el nombre de una operación para ver los detalles.

      Publish Description

      Introduzca una descripción para esta publicación.

    Agregar una versión de API

    Importante

    Actualmente, solo puede agregar versiones a las API compartidas.

    1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API y, en la barra de navegación superior, seleccione una región.

    2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Add Version y configure los siguientes parámetros:

      Parámetro

      Descripción

      Usage

      Métodos compatibles: Path, Query y Header.

      Nota

      • Si selecciona Query como Usage, debe configurar el parámetro Add Query.

      • Si selecciona Header como Usage, debe configurar el parámetro Add Header.

      • Al utilizar el método Path, la ruta completa de la solicitud debe ser: /APIBasePath/VersionNumber/OperationPath.

      • Al utilizar el método Query, use la ruta /APIBasePath/OperationPath e incluya el número de versión en el parámetro de consulta especificado por Add Query.

      • Al utilizar el método Header, use la ruta /APIBasePath/OperationPath e incluya el número de versión en el encabezado de solicitud especificado por Add Header.

    3. (Opcional) Después de agregar la versión, haga clic en la pestaña Version en la parte superior de la página para cambiar entre versiones.

    Consultar el historial de publicaciones

    Nota

    Se conservan los últimos 10 registros de publicación.

    1. Consulte el historial de publicaciones de API compartidas o API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada y luego en la pestaña Publish History.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API, haga clic en la API correspondiente y luego en la pestaña Publish History.

    2. En la columna Actions de una versión histórica, haga clic en View para ver sus detalles.

    Generar un SDK y documentación

    1. Genere un SDK y documentación para API compartidas o API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Generate SDK & Documentation.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

      3. En la esquina superior derecha, seleccione More > Generate SDK & Documentation.

    2. En el cuadro de diálogo More > Generate SDK & Documentation, configure los parámetros y haga clic en Generate and Download.

      Parámetro

      Descripción

      API Version

      Seleccione la versión de la API para la generación del SDK y la documentación.

      Nota

      • Las API con ámbito de instancia no admiten control de versiones, por lo que esta opción no está disponible.

      • Para las API compartidas, esta opción solo está disponible si habilitó la gestión de versiones al crear la API.

      Language

      Lenguajes de SDK compatibles: Java, Golang, Python, Node.js, TypeScript y Swift.

    3. El paquete comprimido se descarga automáticamente en la carpeta predeterminada de su navegador.

      Nota

      Después de descomprimir el paquete, consulte el archivo README.md para obtener instrucciones sobre el uso del SDK.

    Importar una API

    1. Importe una definición de API para API compartidas o API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Import.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

      3. En la esquina superior derecha, seleccione More > Import.

    2. En el panel Create File based on OpenAPI, configure the parameters y luego haga clic en Precheck and Create.

    Cuando importa una API, el nombre de la API se toma del campo info.title en el archivo de definición de OpenAPI. Si info.title no se especifica en el archivo, el sistema genera automáticamente un nombre. No puede cambiar el nombre de una API después de crearla.

    Para cambiar el nombre de una API existente, exporte su archivo de definición de API, modifique el campo info.title en el archivo y luego vuelva a importar el archivo.

    Exportar una API

    1. Exporte una definición de API para API compartidas o API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Import.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

      3. En la esquina superior derecha, seleccione More > Import.

    2. En el cuadro de diálogo Export, haga clic en OK. La definición de la API se descargará en la carpeta de descargas predeterminada de su navegador.

    Cancelar la publicación de una API

    Importante

    Después de cancelar la publicación de una API, sus operaciones dejan de ser accesibles a través de los nombres de dominio asociados. Las solicitudes ya no se procesan, pero la configuración y el historial de publicaciones se conservan. Proceda con precaución.

    1. Cancele la publicación de una API compartida o una API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Shutdown.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

      3. En la esquina superior derecha, seleccione More > Shutdown.

    2. En el cuadro de diálogo Confirm Unpublish, haga clic en Shutdown.

    Eliminar una API

    Importante

    • Antes de eliminar una API publicada, primero debe cancelar su publicación en todas las instancias.

    • Eliminar una API quita permanentemente su configuración, documentación e historial. Esta acción no se puede deshacer. Proceda con precaución.

    1. Elimine una API compartida o una API con ámbito de instancia.

      Shared API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione API. En la barra de navegación superior, seleccione una región.

      2. Haga clic en la API deseada. En la esquina superior derecha, seleccione More > Delete.

      Instance-scoped API

      1. Inicie sesión en la consola de Cloud-native API Gateway. En el panel de navegación izquierdo, seleccione Instance. En la barra de navegación superior, seleccione una región.

      2. En la página Instance, haga clic en el ID de la instancia de gateway deseada. En el panel de navegación izquierdo, seleccione API y luego haga clic en la API correspondiente.

      3. En la esquina superior derecha, seleccione More > Delete.

    2. En el cuadro de diálogo Confirm deletion, haga clic en Delete.