Uso de revisiones para realizar cambios que no producen interrupciones de forma seguraUse revisions to make non-breaking changes safely

Cuando la API esté lista y los desarrolladores empiecen a usarla, tendrá que realizar cambios en dicha API y, al mismo tiempo, no interrumpir a quienes la llaman.When your API is ready to go and starts to be used by developers, you eventually need to make changes to that API and at the same time not disrupt callers of your API. También resulta útil informar a los desarrolladores de los cambios realizados.It's also useful to let developers know about the changes you made. Esto se logra en Azure API Management con las revisiones.We can do this in Azure API Management using revisions. Para más información, consulte Versions & revisions (Versiones y revisiones) y API Versioning with Azure API Management (Control de versiones con Azure API Management).For more information, see Versions & revisions and API Versioning with Azure API Management.

En este tutorial, aprenderá a:In this tutorial, you learn how to:

  • Agregar una nueva revisiónAdd a new revision
  • Realizar cambios que no producen interrupciones en la revisiónMake non-breaking changes to your revision
  • Convertir la revisión en actual y agregar una entrada en el registro de cambiosMake your revision current and add a change log entry
  • Examinar el portal para desarrolladores para ver los cambios y registro de cambiosBrowse the developer portal to see changes and change log

Registro de cambios en el portal para desarrolladores

Requisitos previosPrerequisites

Agregar una nueva revisiónAdd a new revision

Agregar revisión de API

  1. Seleccione la página API.Select APIs page.

  2. Seleccione Demo Conference API en la lista de API (u otra API a la que desee agregar revisiones).Select Demo Conference API from the API list (or other API to which you want to add revisions).

  3. Haga clic en la pestaña Revisiones en el menú junto a la parte superior de la página.Click the Revisions tab from the menu near the top of the page.

  4. Seleccione + Agregar revisión.Select + Add Revision

    Sugerencia

    También puede seleccionar Agregar revisión en el menú contextual ( ... ) de la API.You can also choose Add Revision in the context menu (...) of the API.

  5. Incluya una descripción de la nueva revisión que ayude a saber para qué va a servir.Provide a description for your new revision, to help remember what it will be used for.

  6. Seleccione CrearSelect Create

  7. Ya tenemos creada la revisión.Your new revision is now created.

    Nota

    La API original permanece en Revisión 1.Your original API remains in Revision 1. Esta es la revisión que los usuarios siguen llamando hasta que decida convertir otra en actual.This is the revision your users continue to call, until you choose to make a different revision current.

Realizar cambios que no producen interrupciones en la revisiónMake non-breaking changes to your revision

Modificar revisión

  1. Seleccione Demo Conference API en la lista de API.Select Demo Conference API from the API list.

  2. Seleccione la pestaña Diseño situada junto a la parte superior de la pantalla.Select the Design tab near the top of the screen.

  3. Fíjese en que el selector de revisiones (que está inmediatamente encima de la pestaña de diseño) muestra que la revisión seleccionada es Revisión 2.Notice that the revision selector (directly above the design tab) shows Revision 2 as currently selected.

    Sugerencia

    Use el selector de revisión para alternar entre las revisiones con las que vaya a trabajar.Use the revision selector to switch between revisions that you wish to work on.

  4. Seleccione + Agregar operación.Select + Add Operation.

  5. Establezca que la nueva operación sea POST y especifique test como nombre, nombre para mostrar y dirección URL de la operación.Set your new operation to be POST, and the Name, Display Name and URL of the operation as test.

  6. Guarde la nueva operación.Save your new operation.

  7. Ya hemos hecho un cambio en Revisión 2.We have now made a change to Revision 2. Use el selector de revisión junto a la parte superior de la página para volver a Revisión 1.Use the Revision Selector near the top of the page to switch back to Revision 1.

  8. Observe que la nueva operación no figura en Revisión 1.Notice that your new operation does not appear in Revision 1.

Convertir la revisión en actual y agregar una entrada en el registro de cambiosMake your revision current and add a change log entry

  1. Seleccione la pestaña Revisiones en el menú junto a la parte superior de la página.Select the Revisions tab from the menu near the top of the page.

    El menú de revisión en la pantalla de revisión.

  2. Abra el menú contextual ( ... ) de Revisión 2.Open the context menu (...) for Revision 2.

  3. Seleccione Convertir en actual.Select Make Current.

  4. Active la casilla Post to Public Change log for this API (Publicar en el registro de cambios público de esta API), si quiere publicar notas sobre este cambio.Check Post to Public Change log for this API, if you want to post notes about this change. Especifique una descripción del cambio que puedan ver los desarrolladores, por ejemplo: Revisiones de prueba. Se agregó una nueva operación de "prueba".Provide a description for your change that developers see, for example: Testing revisions. Added new "test" operation.

  5. Revisión 2 es ahora la revisión actual.Revision 2 is now current.

Examinar el portal para desarrolladores para ver los cambios y registro de cambiosBrowse the developer portal to see changes and change log

  1. En Azure Portal, seleccione API.In the Azure portal, select APIs.

  2. Seleccione Portal para desarrolladores en el menú superior.Select Developer Portal from the top menu.

  3. Seleccione API y, después, Demo Conference API.Select APIs, and then select Demo Conference API.

  4. Observe que la nueva operación prueba ahora aparece disponible.Notice your new test operation is now available.

  5. Seleccione API Change History (Historial de cambios de la API) debajo del nombre de la API.Select API Change History from below the API name.

  6. Vea que la entrada en el registro de cambios aparece en esta lista.Notice that your change log entry appears in this list.

    Portal para desarrolladores

Pasos siguientesNext steps

En este tutorial aprendió lo siguiente:In this tutorial, you learned how to:

  • Agregar una nueva revisiónAdd a new revision
  • Realizar cambios que no producen interrupciones en la revisiónMake non-breaking changes to your revision
  • Convertir la revisión en actual y agregar una entrada en el registro de cambiosMake your revision current and add a change log entry
  • Examinar el portal para desarrolladores para ver los cambios y registro de cambiosBrowse the developer portal to see changes and change log

Avance hasta el siguiente tutorial:Advance to the next tutorial: