Esta página se aplica a Apigee y Apigee Hybrid.
En este tema, se explica lo que necesitas saber sobre cómo crear y administrar versiones en el concentrador de APIs.
¿Qué es una versión?
Cada recurso de API en el concentrador de APIs tiene al menos una versión asociada. Puedes pensar en una versión como el estado de una API en un momento determinado. En esencia, las versiones te ayudan a agrupar y organizar tus APIs en función de conjuntos de operaciones, implementaciones, especificaciones y otros atributos subyacentes, como se muestra en la Figura 1.
Figura 1. Cada versión puede tener operaciones, implementaciones y otros atributos.
En el concentrador de APIs, una versión representa una agrupación lógica de API. Por lo general, aunque no necesariamente, esta agrupación gira en torno a las operaciones que puede realizar una API. Por ejemplo, supongamos que tienes una API de Pet Store, y la primera versión de esta API te permite realizar tareas básicas, como agregar una mascota, encontrar una mascota y borrarla de la tienda. Estos son ejemplos de operaciones.
Se recomienda que una versión incluya un conjunto de operaciones de API que se implementan juntas. Por ejemplo, una API de tienda de mascotas puede tener una versión que incluya operaciones de agregar, buscar y borrar, todas implementadas en los mismos entornos.
Otra buena manera de pensar en una versión es que representa la vista del productor de la API. Es la colección de características y capacidades que las personas que compilaron la API le implementaron y esperan que se implementarán con ella.
Crear versiones
Supongamos que los detalles de una API que deseas agregar al concentrador de APIs se capturan en una especificación de OpenAPI. Si es así, puedes agregar la especificación a una versión de la API. Cuando lo haces, el concentrador de APIs analiza la especificación y extrae información de ella, como qué operaciones incluye la API, y almacena esa información con la versión. Si no tienes una especificación de OpenAPI, puedes crear una versión, pero deberás propagarla manualmente con información descriptiva relevante. Otro caso en el que el concentrador de APIS admite el análisis de los detalles de la API a través del registro automático de proxies de API de Apigee.
Puedes subir varios archivos de especificación de API a la misma versión.
¿Cuándo crear una versión nueva?
Si se agregan operaciones nuevas a una API, puede que se requiera la creación de una versión nueva.
Supongamos que el productor de la API agrega una operación nueva a una API y quiere que se implemente en todas las implementaciones asociadas actualmente a la versión. En ese caso, el productor puede elegir no crear una versión nueva de la API. Por otro lado, si el productor realiza un cambio incompatible con versiones anteriores (un cambio rotundo) y elige asociarlo con una implementación nueva, te recomendamos que crees una versión nueva.
Puedes ver que el concentrador de APIs te proporciona flexibilidad para definir y organizar las versiones de las APIs para que se adapten mejor a las necesidades de tu organización y las necesidades de productores de APIs específicos.
Atributos del sistema
Las versiones incluyen los siguientes atributos del sistema de forma predeterminada. Puedes modificar los valores asociados con estos atributos en Configuración. Para obtener más información, consulta Administra atributos.
| Atributo | Descripción |
|---|---|
| Lifecycle | El ciclo de vida hace referencia a un conjunto ordenado de etapas por las que una API debe avanzar, desde la concepción hasta el final del ciclo de vida. Debido a que cada versión de una API suele moverse por su propio ciclo de vida por separado, no establecemos directamente la etapa del ciclo de vida de una API, sino que permitimos que cada versión de API tenga una etapa de ciclo de vida asignada. |
| Cumplimiento | Mediante la configuración, puedes definir valores para representar los detalles de cumplimiento de interés para tu organización o equipo. Para obtener más información, consulta Administra atributos. |
| Acreditación | A través de la configuración, puedes definir valores para representar los detalles de la acreditación de interés para tu organización o equipo. Para obtener más información, consulta Administra atributos. |
| Documentación | Un vínculo a la documentación de la API a la que se adjunta la versión. |
Atributos definidos por el usuario
Según las necesidades de tu organización o tu equipo, puedes definir atributos personalizados (pares nombre/valor) para las versiones. ConsultA Administra atributos.