Publicación de varias versiones de la APIPublish multiple versions of your API

A veces resulta poco práctico que todos los que llaman a la API usen exactamente la misma versión.There are times when it is impractical to have all callers to your API use exactly the same version. Si alguien que llama a una API quiere actualizarla a una versión posterior, querrá hacerlo con un método que sea fácil de comprender.When callers want to upgrade to a later version, they want to be able to do this using an easy to understand approach. Esto se puede hacer en Azure API Management con las versiones.It is possible to do this using versions in Azure API Management. Para más información, consulte Versions & revisions (Versiones y revisiones).For more information, see Versions & revisions.

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

  • Agregar una nueva versión a una API existenteAdd a new version to an existing API
  • Elegir un esquema de versiónChoose a version scheme
  • Agregar la versión a un productoAdd the version to a product
  • Examinar el portal para desarrolladores para ver la versiónBrowse the developer portal to see the version

Versión que se muestra en el portal para desarrolladores

Requisitos previosPrerequisites

Agregar una nueva versiónAdd a new version

Menú contextual de la API: agregar versión

  1. Seleccione Demo Conference API en la lista de API.Select Demo Conference API from the API list.
  2. Seleccione el menú contextual ( ... ) junto a ella.Select the context menu (...) next to it.
  3. Seleccione + Agregar versión.Select + Add Version.

Sugerencia

Las versiones también se pueden habilitar al crear una API desde cero (para ello, seleccione ¿Definir versión de esta API? en la pantalla Agregar API).Versions can also be enabled when you first create a new API - select Version this API? on the Add API screen.

Elegir un esquema de control de versionesChoose a versioning scheme

Con Azure API Management, puede elegir la forma en la que quiere que quienes llamen a una API puedan especificar qué versión de dicha API quieren.Azure API Management allows you to choose the way in which you allow callers to specify which version of your API they want. Especifique qué versión de la API va a usar, para lo que seleccionará un esquema de control de versiones.You specify which API version to use by selecting a versioning scheme. Este esquema puede ser una ruta de acceso, un encabezado o una cadena de consulta.This scheme can be either path, header or query string. En el ejemplo siguiente, la ruta de acceso se utiliza para seleccionar el esquema de control de versiones.In the following example, path is used to select the versioning scheme.

Pantalla Agregar versión

  1. Deje ruta de acceso seleccionada como esquema de control de versiones.Leave path selected as your versioning scheme.

  2. Escriba demo-conference-api-v1 en el campo Nombre.Type demo-conference-api-v1 in the Name field.

    Nota

    Una versión, de hecho, es una nueva API que se basa en la revisión de otra API.Version is in fact a new API based off an API's revision. Nombre es el nuevo nombre de la API y debe ser único en la instancia de API Management.Name is the new API's name and it must be unique across API Management instance.

  3. Escriba v1 en el campo Identificador de la versión.Type v1 in the Version identifier field.

    Sugerencia

    Si selecciona encabezado o cadena de consulta como esquema de control de versiones, debe proporcionar un valor más: el nombre del parámetro de encabezado o de cadena de consulta.If you select header or query string as a versioning scheme, you need to provide an additional value - the name of the header or query string parameter.

  4. Seleccione Crear para configurar la nueva versión.Select Create to set up your new version.

  5. Debajo de la directiva Demo Conference API en la lista de API, ahora verá dos API distintas: Original y v1.Underneath Demo Conference API in the API List, you now see two distinct APIs - Original, and v1.

    Versiones que aparecen en una API en Azure Portal

    Nota

    Si agrega una versión a una API sin control de versiones, se creará automáticamente un Original (que responde a la dirección URL predeterminada).If you add a version to a non-versioned API, an Original will be automatically created - responding on the default URL. Esto garantiza que quienes estén llamando en ese momento no sufran ninguna interrupción a causa del proceso de adición de la versión.This ensures that any existing callers are not broken by the process of adding a version. Si crea una API con las versiones habilitadas desde el principio, no se creará un original.If you create a new API with versions enabled at the start, an Original is not created.

  6. Ahora puede modificar y configurar v1 como una API independiente de Original.You can now edit and configure v1 as an API that is separate to Original. Los cambios en una versión no afectan a otra.Changes to one version do not affect another.

Agregar la versión a un productoAdd the version to a product

Para que quienes realizan las llamadas vean la versión nueva, debe agregarse a un producto.In order for callers to see the new version, it must be added to a product.

Productos de API Management

  1. Seleccione Productos en la página del modelo de implementación clásica.Select Products from the classic deployment model page.
  2. Seleccione Ilimitado.Select Unlimited.
  3. Seleccione API.Select APIs.
  4. Seleccione Agregar.Select Add.
  5. Seleccione Demo Conference API, versión v1.Select Demo Conference API, Version v1.
  6. Haga clic en Seleccionar.Click Select.

Examinar el portal para desarrolladores para ver la versiónBrowse the developer portal to see the version

  1. Seleccione Portal para desarrolladores en el menú superior.Select Developer Portal from the top menu.
  2. Seleccione API y haga clic en Demo Conference API.Select APIs and click on the Demo Conference API.
  3. Debe ver una lista desplegable con varias versiones junto al nombre de la API.You should see a dropdown with multiple versions next to the API name.
  4. Seleccione v1.Select v1.
  5. Fíjese en la Dirección URL de la solicitud de la primera operación de la lista.Notice the Request URL of the first operation in the list. Refleja que la ruta de acceso de la dirección URL de la API incluye v1.It shows that the API URL path includes v1.

Pasos siguientesNext steps

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

  • Agregar una nueva versión a una API existenteAdd a new version to an existing API
  • Elegir un esquema de versiónChoose a version scheme
  • Agregar la versión a un productoAdd the version to a product
  • Examinar el portal para desarrolladores para ver la versiónBrowse the developer portal to see the version

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