Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Control de versiones

En este tema, se describen las estrategias de control de versiones que usan las API de Google. En general, estas estrategias se aplican a todos los servicios administrados por Google.

A veces, es necesario realizar cambios no compatibles con las versiones anteriores (o "rotundos") en una API. Estos tipos de cambios pueden causar problemas o fallas en un código que dependa de la funcionalidad original.

Las API de Google usan un esquema de control de versiones para evitar cambios rotundos. Además, las API de Google hacen que algunas funciones solo estén disponibles en ciertos niveles de estabilidad, como en los componentes alfa y beta.

Orientación

Todas las interfaces de la API de Google deben proporcionar un número de versión principal, codificado al final del paquete protobuf, y se incluye como la primera parte de la ruta de URI para las API de REST. Si una API ingresa un cambio rotundo, como quitar o cambiar de nombre un campo, debe aumentar su número de versión de la API para garantizar que el código de usuario existente no falle repentinamente.

Una versión principal nueva de una API no debe depender de una versión principal anterior de la misma API. Una API puede depender de otras API, con la expectativa de que el emisor comprende la dependencia y el riesgo de estabilidad asociados con esas API. En este caso, una versión estable de la API debe depender solo de versiones estables de otras API.

Diferentes versiones de la misma API deben poder funcionar al mismo tiempo dentro de una única aplicación cliente durante un período de transición razonable. Este período le permite al cliente realizar una transición sin problemas a la versión más reciente. Una versión anterior debe pasar por un período de baja razonable y bien comunicado antes de cerrarse.

Para las versiones con estabilidad alfa o beta, las API deben agregar el nivel de estabilidad después del número de versión principal en el paquete protobuf y la ruta URI mediante una de las siguientes estrategias:

  • Control de versiones basado en canales (recomendado)
  • Control de versiones basado en actualizaciones

Control de versiones basado en canales

Un canal de estabilidad es una actualización de larga duración a un nivel de estabilidad determinado que recibe actualizaciones locales. No hay más de un canal por nivel de estabilidad para una versión principal. En esta estrategia, existen hasta tres canales disponibles: Alfa, Beta y estable.

El canal alfa y el canal beta deben tener adjunto su nivel de estabilidad, pero el canal estable no debe tener agregado el nivel de estabilidad. Por ejemplo, v1 es una versión aceptable para el canal estable, pero v1beta o v1alpha no lo son. Del mismo modo, v1beta o v1alpha son versiones aceptables para el canal alfa y el canal beta correspondiente, pero v1 no se admite. Cada uno de estos canales recibe nuevas funciones y actualizaciones “en el lugar”.

La funcionalidad del canal beta debe ser un superconjunto de la funcionalidad del canal estable, y la funcionalidad del canal Alfa debe ser un superconjunto de la funcionalidad del canal Beta.

Baja de la funcionalidad de la API

Los elementos de la API (campos, mensajes, RPC) pueden marcarse como obsoletos en cualquier canal para indicar que ya no deben usarse:

// A representation of a scroll.
// Books are now preferred over scrolls.
message Scroll {
  option deprecated = true;

  // ...
}

La funcionalidad de la API obsoleta no debe pasar de alfa a beta ni de beta a estable. En otras palabras, la funcionalidad no debe llegar “obsoleta” a ningún canal.

La funcionalidad del canal Beta puede quitarse después de que se considere obsoleta durante un período suficiente. Recomendamos 180 días. Para las funciones que existen solo en el canal alfa, la baja es opcional y las funcionalidades podrían quitarse sin previo aviso. Si la funcionalidad está obsoleta en el canal alfa de una API antes de su eliminación, la API debe aplicar la misma anotación y podría usar cualquier período que desee.

Control de versiones basado en actualizaciones

Un lanzamiento individual es una actualización Alfa o Beta que se espera que esté disponible durante un período limitado antes de que se incorpore su funcionalidad en el canal estable. Después de esa fecha, se lanzará el lanzamiento individual. apagar. Cuando se usa una estrategia de control de versiones basada en actualizaciones, una API puede tener cualquier cantidad de actualizaciones individuales en cada nivel de estabilidad.

Las versiones Alfa y Beta deben tener su nivel de estabilidad anexado, seguido de un número de actualización creciente. Por ejemplo, v1beta1 o v1alpha5. Las API deben documentar el orden cronológico de estas versiones en su documentación (como los comentarios).

Cada actualización Alfa o Beta puede actualizarse con cambios compatibles con versiones anteriores. En las versiones Beta, las actualizaciones incompatibles con versiones anteriores deben realizarse mediante el aumento del número de lanzamiento y la publicación de una nueva actualización con el cambio. Por ejemplo, si la versión actual es v1beta1, a continuación se lanzará v1beta2.

Las versiones Alfa y Beta deben cerrarse una vez que su funcionalidad llegue al canal estable. Un lanzamiento Alfa puede cerrarse en cualquier momento, mientras que una versión Beta debe permitir que los usuarios cuenten con un período de transición razonable. Le recomendamos 180 días.