Ir al contenido
↑↓ moverse↵ abriresc cerrar

Ejemplos

Recorre una lista por páginas

Usa parámetros query para leer una página, pedir la siguiente y buscar, y lee lo que la API devuelve sobre el total.

3 min de lectura

Las listas de una API llegan por páginas. Pides una página con parámetros query como limit y skip, y la respuesta dice cuántos elementos existen en total.

Qué prueba: que los parámetros query modelan la respuesta (tamaño de página, inicio, campos, búsqueda) y que un paso posterior puede comparar contra un output anterior.

pagination-query.arazzo.yaml dummyjson.openapi.yaml
  1. Descarga los dos archivos de arriba en una misma carpeta.
  2. En Luvin, pulsa Nueva colección, o abre una colección que ya tengas.
  3. En el inicio de la colección, pulsa Importar Arazzo o contratos y elige los dos archivos descargados.
  4. En la barra lateral, abre el workflow pageThroughProducts.
  5. En la barra de ejecución, elige API real.
  6. Pulsa Ejecutar. Los resultados se abren abajo.
pagination-query.arazzo.yaml
arazzo: 1.0.1
info:
title: Page through a product list
version: 1.0.0
sourceDescriptions:
- name: dummyjson
url: ./dummyjson.openapi.yaml
type: openapi
workflows:
- workflowId: pageThroughProducts
summary: Read the first page, the next page and a search
inputs:
type: object
properties:
pageSize: { type: integer, example: 5 }
nextSkip: { type: integer, example: 5 }
search: { type: string, example: phone }
steps:
- stepId: firstPage
operationId: listProducts
parameters:
- name: limit
in: query
value: $inputs.pageSize
- name: skip
in: query
value: 0
- name: select
in: query
value: title,price
successCriteria:
- condition: $statusCode == 200
- condition: $response.body#/skip == 0
outputs:
total: $response.body#/total
firstTitle: $response.body#/products/0/title
- stepId: nextPage
operationId: listProducts
parameters:
- name: limit
in: query
value: $inputs.pageSize
- name: skip
in: query
value: $inputs.nextSkip
- name: select
in: query
value: title,price
successCriteria:
- condition: $statusCode == 200
- condition: $response.body#/total == $steps.firstPage.outputs.total
outputs:
skip: $response.body#/skip
firstTitle: $response.body#/products/0/title
- stepId: searchProducts
operationId: searchProducts
parameters:
- name: q
in: query
value: $inputs.search
- name: limit
in: query
value: $inputs.pageSize
- name: select
in: query
value: title,price
successCriteria:
- condition: $statusCode == 200
- condition: $response.body#/total > 0
outputs:
matches: $response.body#/total
outputs:
total: $steps.firstPage.outputs.total
firstTitle: $steps.firstPage.outputs.firstTitle
secondPageFirstTitle: $steps.nextPage.outputs.firstTitle
matches: $steps.searchProducts.outputs.matches
Línea Qué hace
pageSize, nextSkip, search (15-17) Tres inputs, con valores de ejemplo, para que los cambies sin editar los pasos.
limit $inputs.pageSize / skip 0 (24-27) Parámetros query de la primera página: cuántos elementos y desde dónde.
$response.body#/skip == 0 (33) Un criterio de éxito sobre un valor del body de la respuesta.
total y firstTitle (35-36) Outputs tomados de la respuesta. products/0/title es el título del primer elemento de la página.
skip $inputs.nextSkip (45) La página siguiente empieza donde dice este input. Mira la nota de abajo.
$response.body#/total == $steps.firstPage.outputs.total (51) Un criterio que compara esta respuesta con un output del primer paso: el total no debe cambiar entre páginas.
q $inputs.search (60) El texto de búsqueda va en el parámetro query q.
Paso Estado HTTP Outputs
firstPage 200 total = 194, firstTitle = Essence Mascara Lash Princess
nextPage 200 skip = 5, firstTitle = Calvin Klein CK One
searchProducts 200 matches = 23

Los outputs del workflow son total = 194, firstTitle, secondPageFirstTitle y matches = 23. El veredicto es Pasó. Los totales vienen del catálogo en vivo de DummyJSON y pueden cambiar si él cambia.

  • Una página cerca del final. Pon nextSkip en 190 (el catálogo tiene 194 productos). nextPage sigue respondiendo 200 y su firstTitle ahora es Rolex Cellini Moonphase.
  • Una búsqueda sin resultados. Pon search en zzzzqq. DummyJSON responde 200 con total 0, así que el criterio $response.body#/total > 0 falla: searchProducts falla y el workflow termina No pasó. Un resultado vacío es una respuesta válida para la API, y tus criterios deciden si te sirve.
  • Páginas más chicas. Pon pageSize en 2 y nextSkip en 2: la segunda página ahora empieza en el tercer producto, Powder Canister.