Diseñar workflows
Marca los campos obligatorios de un request
Dile a Luvin qué campos exige la API en un request que usas como paso, qué cambia eso en el workflow y sus casos, y dónde se guarda.
Un request que guardaste no tiene un contrato que diga qué campos exige la API. Tú lo sabes, así que se lo dices a Luvin. Hazlo cuando armes un workflow a partir de requests guardados. Tu respuesta decide qué datos pide el workflow y qué casos negativos genera Luvin.
Ejemplo: Create order
Sección titulada «Ejemplo: Create order»Agregas el request Create order a un workflow. Se abre el diálogo ¿Qué exige la API en «Create order»? Marcas lo que la API exige y haces clic en Guardar.
| Grupo | Fila | Estado |
|---|---|---|
| Query params | bank |
obligatorio |
| Headers | x-api-key |
obligatorio |
| Body | address/city |
obligatorio |
requiredFields: - query:bank - header:x-api-key - body:address/cityPor qué importa
Sección titulada «Por qué importa»Una operación de un contrato trae esta información: el contrato dice que bank es obligatorio. Un request guardado es solo una llamada que funcionó una vez, así que no dice si bank es obligatorio o simplemente estaba presente.
Lo que marcas tiene dos efectos:
- Datos obligatorios. Cuando conviertes un valor fijo en un input, ese input es obligatorio solo si marcaste su campo como obligatorio. Mira Armar desde requests guardados.
- Casos negativos. Para cada input obligatorio, Luvin genera un caso que lo omite, Sin el input obligatorio “…”, y comprueba que la API lo rechace. Mira Casos.
Lo que no marques queda como opcional.
Marca los campos obligatorios
Sección titulada «Marca los campos obligatorios»La primera vez que usas un request
Sección titulada «La primera vez que usas un request»- En la pestaña Diseño, arrastra un request desde Requests de la colección hasta el lienzo.
- Se abre el diálogo ¿Qué exige la API en «Create order»?
Después, desde el paso
Sección titulada «Después, desde el paso»- Haz clic en el paso que viene de un request. Su panel empieza con Del request «Create order».
- A la derecha de esa línea, haz clic en Marcar campos obligatorios. Después de responder una vez, el enlace dice Campos obligatorios (3), con la cantidad que marcaste. Al apuntarlo aparece Qué campos de este request exige la API.
El diálogo es el mismo en ambos casos.
El diálogo
Sección titulada «El diálogo»Bajo la introducción, el diálogo lista todos los campos del request en cuatro grupos:
| Grupo | Qué lista |
|---|---|
| Ruta | Los parámetros de la ruta, como {id}. Siempre son obligatorios y no puedes desmarcarlos: sin ellos la URL apunta a otro recurso. |
| Query params | Los parámetros de query del request. |
| Headers | Los headers del request, salvo los que Luvin agrega desde otras pestañas: Content-Type, Authorization, Content-Length y Host. |
| Body | Los campos simples del body (texto, número, verdadero/falso), escritos como su ruta, por ejemplo bank o address/city. |
Cada fila tiene una casilla, el nombre del campo, el valor que el request envía ahora y la palabra obligatorio u opcional.
- Marca los campos que la API exige.
- Para cambiarlos todos a la vez, haz clic en Marcar todos o en Ninguno.
- Haz clic en Guardar.
La primera vez, el otro botón dice Ahora no: cierra el diálogo sin una respuesta, y Luvin vuelve a preguntar la próxima vez que agregues ese request a un workflow. Después, el botón dice Cancelar. Esc también cierra el diálogo.
Guardar sin ninguna casilla marcada también es una respuesta: dice que nada es obligatorio además de los parámetros de la ruta.
Dónde se guarda
Sección titulada «Dónde se guarda»Al pie del diálogo: Se guarda en el request: vale para todos los workflows que lo usen. La respuesta se guarda en el archivo del request, no en el workflow, así que respondes una vez por request. En un workspace, la lista está en requests/<nombre>.request.yaml, bajo requiredFields, como en el ejemplo del comienzo. Cada elemento lleva el lugar del campo (query, header o body) y su nombre. Los nombres de los headers van en minúsculas. Los parámetros de la ruta no se listan, porque siempre son obligatorios.
El workflow no cambia al guardar. Luvin reconstruye el contrato que mantiene para tus requests, y los pasos leen ahí la respuesta nueva. Mira Armar desde requests guardados.