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 una expectativa de que el emisor de la llamada comprende el riesgo de dependencia y estabilidad asociado con esas API. En este caso, una versión de API estable debe depender solo de versiones estables de otras API.

Las diferentes versiones de la misma API deben poder funcionar al mismo tiempo dentro de una única aplicación cliente durante un período razonable de transición. Este período le permite al cliente realizar la 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 comunicardo antes de apagarse.

En el caso de las versiones que tienen estabilidad Alfa o Beta, las API deben agregar el nivel de estabilidad después del número de versión principal en el paquete del protobuf y la ruta de acceso del URI con uno de los siguientes comandos: estas estrategias:

  • Control de versiones basado en canales (recomendado)
  • Control de versiones basado en el lanzamiento
  • Control de versiones basado en la visibilidad

Control de versiones basado en canales

Un canal de estabilidad es una versión de larga duración en 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. Con esta estrategia, hay 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 Beta y Alfa correspondiente, pero v1 no se acepta en ninguna de ellas. 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.

Dar de baja 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:

// Represents a scroll. Books are 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 el lanzamiento

Una actualización individual es una versión Alfa o Beta que se espera que esté disponible durante un período de tiempo limitado antes de que su funcionalidad se incorpore al canal estable, después de lo cual la versión individual será apagar, Cuando se usa una estrategia de control de versiones basada en el lanzamiento, 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 a la versión, seguido de un número de actualización de aumento. 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 se puede actualizar en su lugar con cambios compatibles con las versiones anteriores. En el caso de las versiones Beta, las actualizaciones incompatibles con versiones anteriores deben realizar el aumento del número de lanzamiento y la publicación de una nueva versión con el cambio. Por ejemplo, si la versión actual es v1beta1, entonces v1beta2 se lanza a continuación.

Las versiones Alfa y Beta deben cerrarse después de que su funcionalidad alcanza el canal estable. Una versión Alfa puede apagarse en cualquier momento, mientras que una versión Beta debe permitir que los usuarios realicen un período de transición razonable. Recomendamos 180 días.

Control de versiones basado en la visibilidad

La visibilidad de la API es una característica avanzada que proporciona la infraestructura de la API de Google. Permite que los productores de API expongan varias vistas de API externas desde una superficie de API interna, y cada vista se asocia con una etiqueta de visibilidad de la API, como las siguientes:

import "google/api/visibility.proto";

message Resource {
  string name = 1;

  // Preview. Do not use this feature for production.
  string display_name = 2
    [(google.api.field_visibility).restriction = "PREVIEW"];
}

Una etiqueta de visibilidad es una string que distingue entre mayúsculas y minúsculas que se puede usar para etiquetar cualquier elemento de la API. Por convención, las etiquetas de visibilidad siempre deben usar mayúsculas y minúsculas: Se aplica una etiqueta PUBLIC implícita a todos los elementos de la API, a menos que se aplique una etiqueta de visibilidad explícita, como en el ejemplo anterior.

Cada etiqueta de visibilidad es una lista permitida. Los productores de API necesitan otorgar etiquetas de visibilidad a los consumidores de la API para que puedan usar las características de API asociadas con las etiquetas. En otras palabras, una etiqueta de visibilidad de API es como una versión de API con LCA.

Se pueden aplicar varias etiquetas de visibilidad a un elemento mediante una string separada por comas (p.ej., "PREVIEW,TRUSTED_TESTER"). Cuando se usan varias etiquetas de visibilidad, el cliente solo necesita una de las etiquetas de visibilidad (OR lógico).

Una sola solicitud a la API solo puede usar una etiqueta de visibilidad. De forma predeterminada, se usa la etiqueta de visibilidad otorgada al consumidor de la API. Un cliente puede enviar solicitudes con una etiqueta de visibilidad explícita de la siguiente manera:

GET /v1/projects/my-project/topics HTTP/1.1
Host: pubsub.googleapis.com
Authorization: Bearer y29....
X-Goog-Visibilities: PREVIEW

Los productores de API pueden usar la visibilidad de la API para el control de versiones de la API, como INTERNAL y PREVIEW. Una nueva función de la API comienza con la etiqueta INTERNAL y, luego, se mueve a la etiqueta PREVIEW. Cuando la función es estable y está disponible para el público en general, todas las etiquetas de visibilidad de la API se quitan de la definición de la API.

En general, la visibilidad de la API es más fácil de implementar que el control de versiones de la API para cambios incrementales, pero depende de la asistencia de infraestructura de API sofisticada. Las API de Google Cloud suelen usar la visibilidad de la API para las funciones de vista previa.