A medida que las API evolucionan para satisfacer las demandas del mercado y aprovechar los avances tecnológicos, la gestión de versiones se vuelve esencial. Las API abiertas sirven como canales cruciales para que los equipos técnicos entreguen servicios y datos al exterior. Sin embargo, la evolución del negocio y el progreso tecnológico conducen inevitablemente a múltiples iteraciones de versión de sus endpoints. Este cambio es natural y necesario a medida que los equipos optimizan funcionalidades, introducen nuevas características y corrigen errores.Gestionar múltiples versiones de API es crucial para atender a distintos grupos de usuarios, al tiempo que se garantiza tanto la compatibilidad como la innovación. Este enfoque permite a los equipos entregar servicios estables y en evolución, manteniendo el control de versiones, minimizando las interrupciones para los usuarios existentes y garantizando la continuidad y fiabilidad del negocio.
Es posible que los equipos necesiten ofrecer varias versiones de API simultáneamente, como la más reciente, la estable y las versiones de mantenimiento a largo plazo, para garantizar una interrupción mínima para los usuarios de versiones anteriores.
Aspectos destacados de la característica de versión de API#
Creación completa de versionesSe puede crear una nueva versión de API basada en una versión de API existente, que contenga copias de todos los endpoints de la versión original. Después de la creación, cada endpoint dentro de la versión puede modificarse según sea necesario. Como alternativa, puede comenzar desde una versión de API en blanco y añadir endpoints manualmente.
Uso compartido integralSeleccione una o más versiones de API de su proyecto para publicarlas. Todos los endpoints dentro de las versiones seleccionadas serán visibles para los usuarios. Al publicar, se pueden configurar el nombre para mostrar y los ajustes de slug de la versión de API para mejorar la experiencia del lector.
Cambio con un clicSi se han publicado varias versiones de API, los usuarios pueden cambiar entre ellas mediante un selector de versión ubicado junto al nombre del proyecto en la página pública. Al hacer clic en una versión, se mostrarán todos los endpoints y el contenido relacionados con esa versión específica.
Diferencia entre "Versión de API" y "Rama de sprint"
Versión de API: Diseñada para publicación externa, especialmente cuando los cambios importantes causan incompatibilidades significativas entre versiones. Contiene todos los endpoints, no solo los modificados o añadidos recientemente
Rama de sprint: Utilizada internamente por los equipos de desarrollo, alineada con el concepto de "sprint" en el desarrollo ágil. Cada sprint normalmente crea una rama que incluye solo endpoints nuevos o modificados, excluyendo los que no han cambiado
