Cómo crear releases de APIs

Cómo crear releases de APIs

Objetivo

Este instructivo explica cómo crear un release de una API dentro del workspace de Vor-Tex utilizando un nuevo API Tag. Un tag fija una revisión concreta de la API, y el release la documenta y deja su data lista para copiar a otra cuenta o entorno. En el video se muestra el recorrido completo: el listado de releases, el formulario, la creación del tag y la ficha resultante.

Antes de comenzar

  • Necesita una API con al menos una revisión publicada: es la que va a fijar en el tag.
  • Los releases se administran desde APIs › Releases en el menú lateral del workspace.

Crear un nuevo API Release

  1. Ingrese a la sección APIs del menú lateral, abra Releases y haga clic en Nuevo release.

    Sección APIs con la opción de crear un release Formulario del release con los campos obligatorios
  2. En la pantalla Nuevo API Release, complete los datos generales:

    • Título: un nombre claro para identificar el release. Se muestra como título en la pantalla de detalle.
    • Descripción: una explicación breve del propósito o contenido de la API que se publica. Es opcional.
  3. Elija cómo se asociará la API al release:

    • Seleccionar API Tag: utiliza un tag existente.
    • Crear API Tag: genera un tag nuevo para el release.
    • Pegar data del release: carga la información a partir de la data copiada de otro release, con la opción de publicar la revisión al guardar.

    Para el flujo del video, seleccione Crear API Tag.

  4. Complete los campos del nuevo tag:

    • Nombre de API Tag: un identificador que permita reconocer la API y su versión, por ejemplo ventas-v1.
    • Seleccione un API revision: la revisión que desea incluir. Verifique este valor con cuidado: determina qué revisión queda vinculada al tag.
  5. Revise la información y haga clic en Guardar, en la esquina superior derecha. Los campos con asterisco son obligatorios.

Verificar el release creado

Después de guardar, Vor-Tex abre la pantalla de detalle del API Release. Compruebe que la información coincida con lo ingresado:

Ficha del release con la API y la versión asociadas
  • Título: nombre asignado al release.
  • Descripción: detalle general del release.
  • Api Tag: tag creado para identificar la API y su versión.
  • Api Version: API y revisión asociadas al release.

En la sección Release Data, el botón Copiar la data del release copia al portapapeles la información generada. Esa data puede utilizarse después en otro workspace o cuenta mediante la opción Pegar data del release, que recrea la API con la misma configuración.

Resultado esperado

El release queda creado con un API Tag y una revisión específica asociados, y aparece en el listado de releases. Desde la pantalla de detalle se puede verificar la configuración, copiar la data del release o utilizar las acciones de edición y eliminación disponibles.

Errores frecuentes

  • Guardar está deshabilitado: falta el título, o el nombre del tag o la revisión en el modo Crear API Tag.
  • El nombre del tag ya existe: cada tag es único en la cuenta. Elija otro nombre o use Seleccionar API Tag.
  • La revisión no aparece en la lista: la API no tiene revisiones publicadas. Publique la versión y vuelva a intentar.

Artículos relacionados