Esta página se aplica a Apigee y Apigee Hybrid.
Una API puede tener varias implementaciones. Por ejemplo: diferentes regiones o entornos de etapa de pruebas. Una implementación es una ubicación (una dirección) en la que los usuarios pueden acceder a una API. Una de estas implementaciones se puede indicar como la implementación recomendada.
La pestaña Implementaciones muestra todas las implementaciones de la API que configuró un usuario con permisos de edición. Las implementaciones se enumeran alfabéticamente por entorno.
Visualiza el esquema del registro de API
A continuación, se muestran las relaciones entre las API de concentrador de API, las versiones, las implementaciones y las especificaciones.
Referencia | Elemento | Descripción |
---|---|---|
Registro | Un registro es una colección de API que funciona como catálogo de API. | |
Versión | Una API puede tener varias versiones. Una versión debe corresponder a una interfaz estable que los clientes pueden usar para llamar a una API. Una de estas versiones se puede designar como la versión recomendada. En la terminología de semver , se recomienda que las versiones sean versiones principales. |
|
Deployment | Una API puede tener varias implementaciones, p. ej., diferentes regiones o entornos de etapa de pruebas. Una implementación es una ubicación (una dirección) en la que los usuarios pueden acceder a una API. Una de estas implementaciones puede ser la implementación recomendada. | |
Especificación | Se recomienda, pero no es obligatorio, que una versión de API se describa mediante especificaciones formales, a menudo con diferentes formatos de especificación de API. Uno de estos formatos de especificación puede ser el principal, lo que indica que otras especificaciones de esta versión derivan de él. | |
Revisiones |
|
Cómo agregar una implementación
Para agregar una implementación, haz lo siguiente:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- Selecciona la pestaña Deployments.
- Haz clic en Add deployment.
- Ingresa o selecciona lo siguiente:
- ID: Es un identificador para un recurso de API. El ID solo puede contener letras en minúscula, números y guiones. El ID debe ser único en el proyecto. Los ID deben tener entre 4 y 63 caracteres. Los ID no se pueden cambiar una vez que se crea una implementación.
- Entorno: La ubicación en la que está disponible una instancia de una API. Por ejemplo: producción, etapa de pruebas, prueba, etcétera.
- Puerta de enlace: El tipo de puerta de enlace. El proxy que se usa para entregar y proteger la API. Se define como una taxonomía del sistema.
Versión de la API: La versión de la API que proporciona esta implementación. Si una versión no tiene revisiones, se marca como tal en la lista y no se puede seleccionar.
- Nombre y URL del canal externo: una etiqueta y una URL de un vínculo a un canal externo para la API, como un Portal para desarrolladores
- Información de acceso
- Guía de uso: orientación que especifica el público de la implementación. Por ejemplo, consumo público, pruebas internas, etcétera.
- Extremo del servidor: Es el extremo del servidor para la API.
- Guía de acceso: Contenido de Markdown de formato libre en el que se describe cómo los consumidores de API pueden obtener acceso a la implementación.
- Haz clic en Guardar (o Cancelar).
Edita la implementación
Para editar una implementación, haz lo siguiente:
En la consola de Cloud, ve a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- Selecciona la pestaña Deployments.
- Haz clic en Más > Editar junto a la implementación deseada.
- Realiza las modificaciones necesarias.
Actualizar revisión: esta casilla de verificación se muestra cuando la versión seleccionada actualmente tiene una revisión de especificaciones que es más nueva que la que ya está asignada a la implementación. Selecciona esta casilla para actualizar la revisión de la especificación implementada.
- Haz clic en Guardar (o Cancelar).
Borrar implementación
Para borrar una implementación, haz lo siguiente:
En la consola de Cloud, ve a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- Selecciona la pestaña Deployments.
- Haz clic en Más > Borrar junto a la implementación deseada.
- Haz clic en Borrar (o Cancelar) en el mensaje de confirmación.
Especifica la implementación recomendada
Para configurar o borrar una implementación recomendada, sigue estos pasos:
En la consola de Cloud, ve a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- Selecciona la pestaña Deployments.
- En la fila de implementación deseada, haz clic en Más > Set as recommended. No puedes borrar una implementación recomendada. Solo puedes especificar una implementación diferente como implementación recomendada.
Obtén acceso
Para ver información sobre cómo obtener acceso a una API, sigue estos pasos:
En la consola de Cloud, ve a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- En el panel General o la pestaña Implementaciones, haz clic en Obtener acceso para abrir el panel de la API Acceso. Si no aparece el botón Obtener acceso, no se proporcionó información. Consulta Agrega implementación para obtener instrucciones sobre cómo agregar información de acceso.
Selecciona una Implementación de la lista. Si una implementación no tiene información de acceso, se marca como tal en la lista y no se puede seleccionar.
Cómo ir a un canal externo
Sigue estos pasos para navegar a un canal externo:
En la consola de Cloud, ve a la página del concentrador de APIs.
La página de lista de API se muestra de forma predeterminada.
- En la lista de API, haz clic en una fila de API. La pestaña Descripción general se muestra de forma predeterminada.
- Selecciona la pestaña Deployments.
Haz clic en un vínculo de canal externo para navegar a un canal externo, como un portal, si se definió uno.