El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència

HOME

Introducció a Postman

Postman és una eina popular per a desenvolupar, provar i documentar APIs. És àmpliament utilitzada per desenvolupadors i equips de QA per assegurar-se que les APIs funcionen correctament abans de ser desplegades en producció.

Característiques clau de Postman:

Interfície gràfica d'usuari (GUI): Facilita la creació i l'enviament de peticions HTTP.
Suport per a diferents mètodes HTTP: GET, POST, PUT, DELETE, PATCH, etc.
Gestió de col·leccions: Permet organitzar peticions en col·leccions per a una millor gestió.
Variables d'entorn: Facilita la reutilització de valors com URLs, tokens d'autenticació, etc.
Automatització de proves: Permet escriure scripts per automatitzar les proves.
Documentació d'APIs: Genera documentació interactiva per a les APIs.

Instal·lació de Postman

Postman està disponible com a aplicació d'escriptori per a Windows, macOS i Linux, així com una extensió per a Chrome. Pots descarregar-lo des del lloc web oficial de Postman.

Primeres passes amb Postman

Creació d'una petició bàsica

Obre Postman i fes clic a "New" per crear una nova petició.
Selecciona "Request".
Assigna un nom a la petició i selecciona o crea una col·lecció on desar-la.
Introdueix l'URL de l'API que vols provar.
Selecciona el mètode HTTP (GET, POST, etc.).
Fes clic a "Send" per enviar la petició.

Exemple pràctic: Petició GET

Suposem que volem fer una petició GET a una API pública que retorna informació sobre usuaris. Utilitzarem l'API de JSONPlaceholder per a aquest exemple.

URL: https://jsonplaceholder.typicode.com/users
Mètode HTTP: GET

Pas a pas:

Obre Postman.
Crea una nova petició i assigna-li el nom "Get Users".
Introdueix l'URL: https://jsonplaceholder.typicode.com/users.
Selecciona el mètode GET.
Fes clic a "Send".

Resultat esperat

[
  {
    "id": 1,
    "name": "Leanne Graham",
    "username": "Bret",
    "email": "[email protected]",
    ...
  },
  ...
]

Treballant amb col·leccions

Les col·leccions en Postman permeten organitzar peticions relacionades en grups. Això és especialment útil per a projectes grans amb moltes peticions.

Creació d'una col·lecció

Fes clic a "New" i selecciona "Collection".
Assigna un nom a la col·lecció.
Afegeix peticions a la col·lecció arrossegant-les des de la llista de peticions o creant-ne de noves dins de la col·lecció.

Variables d'entorn

Les variables d'entorn permeten definir valors reutilitzables que poden ser utilitzats en múltiples peticions. Això és útil per a gestionar diferents entorns (dev, staging, prod).

Creació de variables d'entorn

Fes clic a la icona de l'engranatge a la part superior dreta i selecciona "Manage Environments".
Crea un nou entorn i defineix les variables necessàries.
Utilitza les variables en les teves peticions utilitzant la sintaxi {{variable_name}}.

Exemple pràctic: Utilització de variables d'entorn

Defineix una variable d'entorn anomenada base_url amb el valor https://jsonplaceholder.typicode.com.
En la teva petició, utilitza {{base_url}}/users com a URL.

Automatització de proves

Postman permet escriure scripts per automatitzar les proves. Pots escriure scripts en JavaScript per validar respostes, establir variables, etc.

Exemple de script de prova

Suposem que volem validar que la resposta de la nostra petició GET a https://jsonplaceholder.typicode.com/users té un codi d'estat 200 i que el cos de la resposta conté una llista d'usuaris.

Després d'enviar la petició, ves a la pestanya "Tests".
Afegeix el següent script:

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Response is an array", function () {
    pm.expect(pm.response.json()).to.be.an('array');
});

Documentació d'APIs amb Postman

Postman permet generar documentació interactiva per a les teves APIs. Pots compartir aquesta documentació amb el teu equip o amb desenvolupadors externs.

Creació de documentació

Selecciona una col·lecció.
Fes clic a "Generate Collection Documentation".
Personalitza la documentació i genera un enllaç per compartir.

Exercicis pràctics

Exercici 1: Petició POST

Crea una nova petició POST a https://jsonplaceholder.typicode.com/posts.
Afegeix el següent cos JSON a la petició:

{
  "title": "foo",
  "body": "bar",
  "userId": 1
}

Envia la petició i valida que la resposta té un codi d'estat 201.

Solució

Crea una nova petició POST.
Introdueix l'URL: https://jsonplaceholder.typicode.com/posts.
Selecciona el mètode POST.
Ves a la pestanya "Body", selecciona "raw" i "JSON".
Introdueix el cos JSON proporcionat.
Fes clic a "Send".
Afegeix el següent script de prova:

pm.test("Status code is 201", function () {
    pm.response.to.have.status(201);
});

Conclusió

Postman és una eina poderosa per a desenvolupar, provar i documentar APIs. Amb les seves característiques avançades com les col·leccions, les variables d'entorn i l'automatització de proves, Postman facilita la gestió i la validació de les teves APIs. Practica amb els exercicis proporcionats per familiaritzar-te amb les seves funcionalitats i millorar les teves habilitats en proves d'APIs.

Postman per a proves d'APIs