Revisiones en Azure API Management

SE APLICA A: Todos los niveles de API Management

Las revisiones permiten realizar cambios en las API de una manera controlada y segura. Cuando quiera realizar cambios, cree una nueva revisión. Después, puede editar y probar la API sin molestar a los consumidores de la API. Cuando esté listo, haga que la revisión esté actualizada. Al mismo tiempo, puede publicar opcionalmente una entrada en el registro de cambios para mantener a los consumidores de api actualizados con los cambios realizados. 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 puedes:

• Realice cambios en las directivas y definiciones de API de forma segura, sin alterar la API de producción.
• Pruebe los cambios antes de publicarlos.
• Documente los cambios que realice para que los desarrolladores puedan comprender lo que es nuevo.
• Revertir cualquier operación si surgen problemas.

Para empezar a trabajar con las revisiones, siga nuestro tutorial.

Acceso a revisiones específicas

Se puede acceder a cada revisión de la API mediante una dirección URL especialmente formada. Anexe ;rev={revisionNumber} al final de la dirección URL de la API, pero antes de la cadena de consulta, para acceder a una revisión específica de esa API. Por ejemplo, puede usar esta dirección URL para acceder a la revisión 3 de la customers API:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

De forma predeterminada, cada revisión tiene la misma configuración de seguridad que la revisión actual. Puede cambiar deliberadamente las directivas de una revisión específica si desea aplicar una seguridad diferente para cada revisión. Por ejemplo, es posible que quiera agregar una directiva de filtrado de IP para evitar que los autores de llamadas externos accedan a una revisión que todavía está en desarrollo.

Nota:

;rev={id} debe anexarse al identificador de la API, no a la ruta de acceso del identificador URI.

Revisión actual

Se puede establecer una sola revisión como revisión actual . Esta revisión es la que se usa para todas las solicitudes de API que no especifican un número de revisión explícito en la dirección URL. Puede revertir a una revisión anterior estableciendo esa revisión como actual.

Puede establecer una revisión como actual mediante Azure Portal. Si usa PowerShell, puede usar el New-AzApiManagementApiRelease cmdlet .

Descripciones de revisiones

Al crear una revisión, puede establecer una descripción para sus propios fines de seguimiento. Las descripciones no se muestran a los usuarios de la API.

Al establecer una revisión como actual, también puede especificar opcionalmente una nota de registro de cambios pública. El registro de cambios se incluye en el portal para desarrolladores para que los usuarios de la API puedan ver. Puede modificar la nota del registro de cambios mediante el Update-AzApiManagementApiRelease cmdlet de PowerShell.

Precaución

Si está editando una revisión no actual de una API, no puede cambiar las siguientes propiedades:

• Nombre
• Tipo
• Description
• Es necesaria una suscripción.
• Versión de API
• Descripción de la versión de la API
• Ruta
• Protocolos

Estas propiedades solo se pueden cambiar en la revisión actual. Si las modificaciones cambian cualquiera de estas propiedades en una revisión no actual, se muestra el mensaje Can't change property for non-current revision de error.

Llevar una revisión fuera de línea

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. Puede marcar una revisión como sin conexión mediante Azure Portal.

Nota:

Se recomienda desactivar las revisiones cuando no los estés usando para probar.

Versiones y revisiones

Las versiones y las revisiones son características distintas. Cada versión puede tener varias revisiones, al igual que una API noversionada. Puede usar revisiones sin usar versiones, o al revés. Normalmente, las versiones se usan para separar las versiones de API con cambios importantes, mientras que las revisiones se pueden usar para cambios menores y no importantes en una API.

Si la revisión tiene cambios importantes o si desea convertir formalmente la revisión en una versión beta o de prueba, puede crear una versión a partir de una revisión. Con Azure Portal, seleccione "Crear versión a partir de revisión" en el menú contextual de revisión de la pestaña Revisiones.