En aquest tema, aprendrem com utilitzar scripts a Postman per automatitzar i millorar les nostres proves d'API. Els scripts de Postman ens permeten manipular sol·licituds i respostes, validar dades i gestionar el flux de proves de manera més eficient.
Què són els Scripts de Postman?
Els scripts de Postman són fragments de codi JavaScript que es poden executar abans o després d'una sol·licitud HTTP. Hi ha dos tipus principals de scripts:
- Scripts de Pre-sol·licitud: S'executen abans que s'enviï una sol·licitud. S'utilitzen per configurar la sol·licitud, com ara establir capçaleres o generar dades dinàmiques.
- Scripts de Prova: S'executen després de rebre la resposta d'una sol·licitud. S'utilitzen per validar la resposta, comprovar valors específics i establir condicions per a proves futures.
Exemple de Script de Pre-sol·licitud
Suposem que volem afegir un token d'autenticació a la capçalera de la nostra sol·licitud. Podem utilitzar un script de pre-sol·licitud per fer-ho automàticament:
// Script de Pre-sol·licitud pm.environment.set("authToken", "Bearer abc123xyz"); pm.request.headers.add({key: "Authorization", value: pm.environment.get("authToken")});
Explicació del Codi
pm.environment.set("authToken", "Bearer abc123xyz");
: Estableix una variable d'entorn anomenadaauthToken
amb el valor del token d'autenticació.pm.request.headers.add(...)
: Afegeix una capçalera d'autorització a la sol·licitud utilitzant el valor de la variableauthToken
.
Exemple de Script de Prova
Ara, veurem com validar la resposta d'una sol·licitud per assegurar-nos que el codi d'estat és 200 i que el cos de la resposta conté un camp específic:
// Script de Prova pm.test("Codi d'estat és 200", function () { pm.response.to.have.status(200); }); pm.test("El cos de la resposta conté 'success'", function () { pm.response.to.have.body("success"); });
Explicació del Codi
pm.test(...)
: Defineix una prova amb un nom descriptiu.pm.response.to.have.status(200);
: Comprova que el codi d'estat de la resposta és 200.pm.response.to.have.body("success");
: Comprova que el cos de la resposta conté la paraula "success".
Exercici Pràctic
Objectiu: Crear un script de prova que validi que la resposta d'una sol·licitud conté un camp JSON específic amb un valor esperat.
Instruccions
- Envia una sol·licitud GET a una API que retorni un objecte JSON.
- Escriu un script de prova que comprovi que el camp
status
de la resposta és"active"
.
Solució
// Script de Prova pm.test("El camp 'status' és 'active'", function () { var jsonData = pm.response.json(); pm.expect(jsonData.status).to.eql("active"); });
Explicació de la Solució
var jsonData = pm.response.json();
: Converteix el cos de la resposta a un objecte JSON.pm.expect(jsonData.status).to.eql("active");
: Comprova que el campstatus
de l'objecte JSON és"active"
.
Errors Comuns i Consells
-
Error Comú: No establir correctament les variables d'entorn abans d'utilitzar-les en scripts.
- Consell: Assegura't de definir i inicialitzar les variables d'entorn abans de la seva utilització.
-
Error Comú: No validar correctament el tipus de dades de la resposta.
- Consell: Utilitza
pm.response.json()
per assegurar-te que estàs treballant amb un objecte JSON.
- Consell: Utilitza
Conclusió
Els scripts de Postman són una eina poderosa per automatitzar i millorar les proves d'API. Amb la capacitat de manipular sol·licituds i respostes, podem crear proves més robustes i eficients. En el següent tema, explorarem com utilitzar proves basades en dades amb Postman per augmentar encara més la nostra capacitat de prova.
Curs de Postman i Proves d'API
Mòdul 1: Introducció a les API i Postman
Mòdul 2: Proves Bàsiques d'API amb Postman
- Creació de la Teva Primera Sol·licitud
- Comprensió de la Sol·licitud i la Resposta
- Ús de les Col·leccions de Postman
- Variables d'Entorn a Postman
Mòdul 3: Tècniques Intermèdies de Proves d'API
- Enllaçar Sol·licituds
- Ús de Scripts de Postman
- Proves Basades en Dades amb Postman
- Proves d'APIs RESTful
Mòdul 4: Funcions Avançades de Postman
- Automatització de Proves amb Newman
- Integració Contínua amb Postman
- Servidors Simulats a Postman
- Tècniques Avançades de Scripting
Mòdul 5: Millors Pràctiques de Proves d'API
- Disseny de Casos de Prova Efectius
- Gestió de l'Autenticació
- Gestió d'Errors i Depuració
- Proves de Rendiment amb Postman