Probar una API REST en 5 minutos

Objetivo: partir de una especificación OpenAPI y llegar a una prueba automatizada que verifique un recorrido completo.

1. Importar la especificación (30 segundos)

Archivo ▸ Importar (Ctrl+I) y después la URL de su openapi.json.

Restorm construye el árbol completo: una carpeta por etiqueta, una petición por operación, los parámetros tipados, la documentación y las cabeceras de autenticación preconfiguradas con sus variables.

El árbol producido por la importación OpenAPI, listo para usar: una carpeta por etiqueta (pet, store, user) y una petición rellenada previamente por operación, junto a la subpestaña de inicio de la carpeta de variables

Si su API no tiene especificación, pegue un comando curl: consulte Importar comandos cURL.

2. Rellenar el entorno (1 minuto)

Abra la carpeta de variables creada por la importación. La URL base ya está ahí; complete la variable de autenticación que la importación ha preparado para usted.

Cree un segundo entorno si prueba varios destinos: el selector de la smartbar cambia toda la carpeta de golpe.

3. Enviar una primera llamada (30 segundos)

Abra una petición y haga clic en Send. La respuesta aparece: estado, tiempo, cabeceras y cuerpo en un visor plegable.

Si ha olvidado algo, el valor resuelto que se muestra bajo el campo URL se lo dirá.

4. Construir el escenario (2 minutos)

Clic derecho ▸ Añadir ▸ Escenario. El recorrido «crear, volver a leer, eliminar»:

Requête HTTP « POST /clients »
     └─response──► Assert (eq, 201)
              └─► Définir variable « clientId »   ◄── sélecteur body.id

Requête HTTP « GET /clients/{id} »
     └─response──► Assert (eq, 200)
              └─► Validation schéma (le JSON Schema du client)

Requête HTTP « DELETE /clients/{id} »
     └─response──► Assert (eq, 204)

Las tres peticiones usan {{clientId}} en su URL: la variable de ejecución establecida en el primer paso la leen los siguientes.

Encadénelas cableando el puerto done de cada aserción al puerto in de la petición siguiente: es lo que garantiza el orden.

5. Comprobar (30 segundos)

Haga clic en Reproducir. El registro se va llenando; añada una acción Log después de cada paso para trazar lo que importa.

Conecte una acción Throw a la salida else de sus aserciones críticas: es lo que hará fallar el trabajo de CI.

6. Automatizarlo (30 segundos)

RESTORM_TOKEN=rstk_… restorm \
  --open ./api.restorm \
  --run "Parcours client" \
  --headless \
  --out run.log

Código de salida 0 si todo pasa, 1 en caso contrario. Consulte Ejecución headless y CI para ver los ejemplos de GitHub Actions y GitLab CI.