Tutorial: Publicación de varias versiones de la API

SE APLICA A: Todos los niveles de API Management

Hay situaciones en las que no es práctico que todos los consumidores de API usen la misma versión. Cuando los consumidores están listos para actualizar a una versión más reciente, prefieren un enfoque sencillo y comprensible. Como se muestra en este tutorial, Azure API Management admite la exposición de varias versiones de API para satisfacer esta necesidad.

Para obtener información general, consulte Versiones y Revisiones.

En este tutorial, aprenderá a:

Requisitos previos

• Obtenga información sobre la terminología de Azure API Management.
• Complete el inicio rápido Creación de una instancia de Azure API Management.
• Complete el tutorial Importación y publicación de la primera API.

Agregar una nueva versión

1. Vaya a la instancia de API Management en Azure Portal.
2. En el menú izquierdo, en la sección API , seleccione API.
3. Busque Swagger Petstore - OpenAPI 3.0 en la lista de API. Seleccione los puntos suspensivos (...) junto a Swagger Petstore - OpenAPI 3.0 y, a continuación, seleccione Agregar versión. Agregará valores a la ventana resultante en la sección siguiente.

Elegir un esquema de control de versiones

En API Management, puede elegir cómo especifican los autores de llamadas la versión de la API seleccionando un esquema de control de versiones: Ruta de acceso, Encabezado o Cadena de consulta. En el ejemplo siguiente, path se usa como esquema de control de versiones.

En la ventana Crear una NUEVA API como versión , escriba los valores de la tabla siguiente. Luego, seleccione Crear para crear la versión.

Después de crear la versión, aparece en Swagger Petstore - OpenAPI 3.0 en la lista de API. Ahora verá dos API: Original y v1:

Edición de una versión

Después de agregar la versión, puede editarla y configurarla como una API independiente del original. Los cambios en una versión no afectan a otro (por ejemplo, si agrega o quita operaciones de API o edita la especificación de OpenAPI). Para obtener más información, consulte Editar API.

Agregar la versión a un producto

Para que los autores de llamadas vean la nueva versión, se debe agregar a un producto. Si aún no ha agregado la versión a un producto, puede hacerlo en cualquier momento.

Para agregar la versión a un producto:

1. Vaya a la instancia de API Management en Azure Portal.
2. En API en el panel izquierdo, seleccione Productos.
3. Seleccione el producto y, a continuación, seleccione API en el panel izquierdo.
4. Seleccione +Agregar.
5. Seleccione la API.
6. Haga clic en Seleccionar.

Uso de conjuntos de versiones

Al crear varias versiones, Azure Portal crea un conjunto de versiones, que representa un conjunto de versiones para una única API lógica. Si selecciona el nombre de una API que tiene varias versiones, el portal muestra su conjunto de versiones. Puede personalizar el nombre y la descripción de un conjunto de versiones.

Puede interactuar directamente con los conjuntos de versiones mediante la CLI de Azure:

• Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Introducción a Azure Cloud Shell.

  

• Si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure. Si utiliza Windows o macOS, considere la posibilidad de ejecutar la CLI de Azure en un contenedor Docker. Para obtener más información, consulte Ejecución de la CLI de Azure en un contenedor de Docker.

  • Si usa una instalación local, inicie sesión en la CLI de Azure mediante el comando az login. Siga los pasos que se muestran en el terminal para completar el proceso de autenticación. Para ver otras opciones de inicio de sesión, consulte Autenticación en Azure mediante la CLI de Azure.

  • En caso de que se le solicite, instale las extensiones de la CLI de Azure la primera vez que la use. Para obtener más información sobre las extensiones, consulte Uso y administración de extensiones con la CLI de Azure.

  • Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.

Para ver todos los conjuntos de versiones, ejecute el comando az apim api versionset list:

az apim api versionset list --resource-group <resource-group-name> \
    --service-name <API-Management-service-name> --output table

Cuando Azure Portal crea un conjunto de versiones, asigna un nombre alfanumérico, que aparece en la columna Nombre de la lista. Use este nombre en otros comandos de la CLI de Azure.

Para ver detalles acerca de un conjunto de versiones, ejecute el comando az apim api versionset show:

az apim api versionset show --resource-group <resource-group-name> \
    --service-name <API-Management-service-name> --version-set-id <ID from the Name column>

Para más información sobre las suscripciones, consulte Versiones de Azure API Management.

Visualización de la versión en el portal para desarrolladores

Si usa el portal para desarrolladores, puede ver las versiones de API allí.

1. Seleccione Portal para desarrolladores en la parte superior de la ventana.
2. Seleccione API, y después, Swagger Petstore.
3. Debería ver una lista desplegable que muestra varias versiones junto al nombre de la API.
4. Seleccione v1.
5. Fíjese en la Dirección URL de la solicitud de la primera operación de la lista. Refleja que la ruta de acceso de la dirección URL de la API incluye v1.

Paso siguiente

Vaya al siguiente tutorial: