Revisiones de Azure API Management
SE APLICA A: todos los niveles de API Management
Las revisiones le permiten realizar cambios en las API de una forma controlada y segura. Cuando desee realizar cambios, cree una revisión. Posteriormente, puede editar y probar la API sin molestar a los consumidores de la misma. Cuando esté listo, convierta la revisión en la versión actual. Al mismo tiempo, puede publicar una entrada en el registro de cambios con el fin de mantener al día a los consumidores de la API con los cambios que se han realizado. El registro de cambios se publica en el portal para desarrolladores.
Nota
El portal para desarrolladores no está disponible en el nivel Consumo.
Con las revisiones puede:
- Realizar cambios de forma segura en las definiciones y directivas de la API sin alterar la API de producción.
- Probar los cambios antes de publicarlos.
- Documentar los cambios que realice, con el fin de que los desarrolladores puedan conocer las novedades.
- Revertir cualquier operación si surgen problemas.
Para empezar a usar las revisiones, siga nuestro tutorial.
Acceso a revisiones concretas
Para acceder a todas las revisiones de una API se puede usar una dirección URL con un formato especial. Para acceder a una revisión concreta de esa API, anexe ;rev={revisionNumber} al final de la dirección URL de la API, pero antes de la cadena de consulta. Por ejemplo, esta dirección URL se puede usar para acceder a la revisión 3 de la API de customers:
https://apis.contoso.com/customers;rev=3/leads?customerId=123
De forma predeterminada, todas las revisiones tienen la misma configuración de seguridad que la revisión actual. Puede cambiar deliberadamente las directivas de una revisión específica si desea que se aplique una seguridad diferente a cada revisión. Por ejemplo, tal vez quiera agregar una directiva de filtrado de IP para evitar que los autores de llamadas externos accedan a revisiones que aún estén en desarrollo.
Nota
;rev={id} debe anexarse al identificador de la API, no a la ruta de acceso del identificador URI.
Revisión actual
Solo se puede establecer una única revisión como revisión actual. Esta revisión será la que se use para todas las solicitudes de API que no especifiquen un número de revisión explícito en la dirección URL. Para realizar la reversión a una revisión anterior, establezca esa revisión como la actual.
Se puede establecer una revisión como actual mediante Azure Portal. Si usa PowerShell, puede utilizar el cmdlet New-AzApiManagementApiRelease.
Descripciones de revisiones
Al crear una revisión, puede establecer una descripción para hacer un seguimiento de la misma. Las descripciones no se muestran para los usuarios de la API.
Si establece una revisión como actual, también puede especificar opcionalmente una nota pública en el registro de cambios. El registro de cambios se incluye en el portal para desarrolladores y todos los usuarios de la API pueden verlo. Para modificar la nota del registro de cambios, se usa el cmdlet de PowerShell Update-AzApiManagementApiRelease.
Precaución
Si está editando una revisión no actual de una API, no puede cambiar las siguientes propiedades:
- Nombre
- Escribir
- Descripción
- Suscripción necesaria
- Versión de API
- Descripción de la versión de API
- Ruta de acceso
- Protocolos
Estas propiedades solo se pueden cambiar en la revisión actual. Si las modificaciones cambian cualquiera de las propiedades anteriores de una revisión no actual, se mostrará el mensaje de error Can't change property for non-current revision.
Desconexión de una revisión
Las revisiones se pueden desconectar, lo que hace que los autores de llamadas no puedan acceder a ellas, aunque intenten hacerlo a través de su dirección URL. Para marcar una revisión como sin conexión, use Azure Portal.
Nota
Se recomienda que las revisiones estén sin conexión cuando no se usen para las pruebas.
Versiones y revisiones
Las versiones y las revisiones son características distintas. Cada versión puede tener varias revisiones, como si fuera una API sin versión. Se pueden usar revisiones sin utilizar versiones y viceversa. Normalmente, las versiones se usan para diferenciar aquellas versiones de API que tienen cambios importantes, mientras que las revisiones se pueden usar para cambios menores y no importantes en una API.
Si observa que su revisión tiene cambios importantes o desea convertir formalmente una revisión en una versión beta o de prueba, puede crear una versión a partir de una revisión. En Azure Portal, haga clic en "Crear versión a partir de esta revisión" en el menú contextual de la revisión en la pestaña Revisiones.