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.

Crear un nuevo API Release

  1. Ingresá a la sección APIs del menú lateral y abrí la opción para crear un nuevo release.



  2. En la pantalla Nuevo API Release, completá los datos generales:

    • Título: ingresá un nombre claro para identificar el release. Este nombre se mostrará como título en la pantalla de detalle.
    • Descripción: agregá una explicación breve del propósito o contenido de la API que se publica. El campo se muestra sin asterisco, por lo que es opcional.
  3. Elegí 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 datos copiados previamente.

    Para el flujo de este ejemplo, seleccioná Crear API Tag.

  4. Completá los campos del nuevo tag:

    • Nombre de API Tag: escribí un identificador que permita reconocer la API y su versión, por ejemplo, licences-v1.
    • Seleccione un API revision: elegí la revisión que querés incluir. Verificá cuidadosamente este valor, ya que determina qué revisión quedará vinculada al tag.
  5. Revisá la información y hacé clic en Guardar, en la esquina superior derecha. Los campos señalados con un asterisco son obligatorios.


Formulario Nuevo API Release con la opción Crear API Tag seleccionada.

Verificar el release creado

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

  • 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.



Detalle del API Release con Api Tag, Api Version y la opción Copiar la data del release.

En la sección Release Data, el botón Copiar la data del release permite copiar la información generada. Esa data puede utilizarse posteriormente mediante la opción Pegar data del release.

Resultado esperado

El release queda creado con un API Tag y una revisión específica asociados. 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.