Diseñar workflows
Crear un workflow
Cómo crear un archivo Arazzo, agregarle workflows y ponerle nombre y descripción a cada uno.
Cada workflow vive en un archivo Arazzo dentro de una colección. Esta página muestra cómo crear ese archivo, cómo agregarle más workflows y cómo darle a cada uno un nombre y una descripción.
Ejemplo: el archivo de la Pokédex
Sección titulada «Ejemplo: el archivo de la Pokédex»La colección Pokédex tiene un archivo Arazzo con cuatro workflows. Apunta a los contratos que usa.
- pokemon.arazzo.yaml el archivo con los cuatro workflows
- pokeapi.openapi.yaml
- pokedex-events.asyncapi.yaml
sourceDescriptions: - name: pokeapi url: ./pokeapi.openapi.yaml type: openapiworkflows: - workflowId: pokemonCard summary: Pokemon card steps: - stepId: getPokemon # ...sourceDescriptions lista los contratos. Cada elemento de workflows es un workflow, con su workflowId, su summary y sus steps.
Qué es un archivo Arazzo
Sección titulada «Qué es un archivo Arazzo»Arazzo es un estándar abierto de la OpenAPI Initiative para describir secuencias de llamadas a APIs. Un archivo Arazzo es un archivo de texto de tu colección, por ejemplo pokemon.arazzo.yaml, con dos cosas dentro:
- La lista de contratos que usa (los archivos OpenAPI y AsyncAPI de tus APIs).
- Uno o más workflows armados con las operaciones de esos contratos.
No necesitas leer ni escribir este archivo. La pestaña Diseño lo edita por ti, y la pestaña YAML lo muestra cuando quieres mirarlo.
Un archivo puede tener varios workflows. El ejemplo de la Pokédex tiene un archivo con cuatro: Pokemon card, Type explorer, Battle matchup y Register sighting.
Crea un archivo Arazzo nuevo
Sección titulada «Crea un archivo Arazzo nuevo»Necesitas una colección abierta.
- Haz clic en + (Crear o importar) a la derecha de las pestañas abiertas.
- Elige Nuevo Arazzo.
Luvin crea el archivo nuevo.arazzo.yaml en la colección, le agrega los contratos de la colección y abre su primer workflow, Mi workflow, en la pestaña Diseño. El lienzo está vacío y dice Arrastra aquí la primera operación.
Si ya existe un archivo con ese nombre, el nuevo se llama nuevo-2.arazzo.yaml, y así sucesivamente.
Agrega un workflow a un archivo existente
Sección titulada «Agrega un workflow a un archivo existente»- Abre cualquier workflow de ese archivo y ve a la pestaña Diseño.
- Haz clic en + Workflow en la barra de herramientas sobre el lienzo.
Se agrega al mismo archivo un workflow nuevo y vacío, llamado Nuevo workflow, y se abre en la pestaña Diseño. También aparece en la barra lateral, debajo del archivo.
El + junto a las pestañas ofrece la misma acción como Nuevo workflow en este archivo.
Ponle nombre y descripción a un workflow
Sección titulada «Ponle nombre y descripción a un workflow»El nombre y la descripción están en la parte de arriba del workflow, a la izquierda del botón Ejecutar.
Cambia el nombre
Sección titulada «Cambia el nombre»- Haz clic en el nombre. Se vuelve un campo de texto.
- Escribe el nombre nuevo.
- Pulsa Enter. Pulsa Esc para cancelar.
Mientras escribes, una línea debajo muestra id en el Arazzo: seguido de un identificador, por ejemplo battleMatchup para «Battle matchup». El id es tu nombre sin espacios, tildes ni símbolos. Es lo que el archivo usa para referirse al workflow; la barra lateral y las pestañas siguen mostrando el nombre como lo escribiste.
| Mensaje | Qué hacer |
|---|---|
| Escribe un nombre con al menos una letra o número. | El nombre solo tenía espacios o símbolos. Agrega una letra o un número. |
| Ya hay un workflow «…» en este archivo. | Otro workflow del archivo tiene ese id. Elige un nombre distinto. |
Renombrar es seguro. Luvin actualiza todo lo que apunta al workflow en el archivo: los workflows que dependen de él, los pasos que lo llaman y los valores que leen sus outputs. Sus casos se quedan con él.
Cambia la descripción
Sección titulada «Cambia la descripción»- Haz clic en el texto debajo del nombre. Si el workflow no tiene descripción, dice Agrega una descripción corta.
- Escribe una frase que diga qué hace el workflow, por ejemplo «Crea un pedido y lo lee de vuelta».
- Pulsa Enter.
Un workflow nuevo empieza con el texto de ejemplo Describe aquí qué hace este workflow. Reemplázalo: la descripción se muestra junto al nombre del workflow en cualquier lugar donde otro workflow lo elija, como la lista Workflows de este Arazzo de la paleta.
Lo que tienes ahora
Sección titulada «Lo que tienes ahora»Un workflow vacío tiene dos tarjetas en el lienzo: Inicio, que dice Sin inputs todavía: aparecen solos cuando un paso necesita un dato que nadie le da, y Fin del workflow. Los pasos van entre ellas.