Rekommenderat program: Postman

En snabb presentation om hur man använder Postman för att testa API:er.

När man bygger en backend som ska svara på olika http-anrop så är det ganska skönt att kunna testa dem innan man bygger sin frontend. Den här veckan kommer vi med ett tips om ett program som många av våra backend-utvecklare använder sig av; Postman!

Postman är ett program som används för att testa API:er, det går både att ladda ner som skrivbordsapplikation och använda i browsern, och många av funktionerna är gratis att använda för ensamma utvecklare eller mindre team. I programmet finns många inbyggda funktioner och verktyg för att hjälpa utvecklare testa API:er, allt från låtsas-servrar, flödesscheman och automatiska tester. Men det vi framförallt ska titta på idag är hur man manuellt sätter upp tester och variabler för att kunna hämta och skicka data till sitt API.

Det är snabbt och enkelt att lära sig och komma igång att arbeta med!

Workspace

Det första vi behöver är ett workspace. Det här är din arbetsyta där allting du skriver kommer att samlas och sparas för att du, eller andra, ska kunna komma åt det lätt.

Man kan skapa ett antal olika workspaces för olika projekt och dela dem med andra utvecklare som sitter och arbetar i samma projekt, eller sitta i ett eget. Det går även snabbt att byta mellan olika workspaces för att kunna testa olika projekt, och att bjuda in nya utvecklare till ett redan uppsatt projekt utan att behöva sätta upp en helt ny testmiljö på varje enskild dator.

I menyn på vänstersidan av vårt Workspace kan vi sen ett flertal ikoner, men de som är relevanta för oss idag är Collections och Environments.

Collections

Collections gör att man på ett smidigt sätt kan sätta upp en struktur för att hålla reda på anropen man vill testa.

Man skapar en ny kollektion genom att trycka på plusset, och döper om den antingen genom att högerklicka, trycka på de tre prickarna på höger sida eller pennan bredvid namnet (Postman erbjuder ganska många sätt att göra samma sak, vilket kan vara förvirrande i början, men det är något man snabbt vänjer sig vid).

I sin nya collection sparar man sina GET, POST, PUT, PATCH och DELETE anrop i requests.

När anropet sparas kommer det att märkas med en tagg, så att man lätt kan se vilken typ av anrop det är.

Varje Workspace kan innehålla flera olika collections med egna undermappar och anrop, så att man lätt kan röra sig mellan olika.

Anrop/Request

I anropet (request) kan man lägga in variabler dels direkt i sökvägen för att skapa dynamiska sökvägar genom att omsluta variabel namnet med dubbla måsvingar. Den kommer då att hämta värdet ur det environment vi har angett som aktivt (mer om enviroments strax).

Eller så kan man använda sig av params för att ställa in query-parametrar och värden direkt i anropet, eller koppla parametrar och värden till definierade environment variabler.

Här kan man även ställa in information för auktorisering, headers, body och allt annat man kan behöva för att göra ett lyckat anrop.

Sedan är det bara att skicka iväg det! När man skickar iväg sitt anrop får man svaret direkt i rutan under, med information om responsen från API’et.

(här har vi gjort ett GET anrop till techys öppna API som ger tillbaka meningar som låter “techiga”)

Environments

Här kan du deklarera och spara variabler som kan kallas på och användas i workspacet, det kan vara allt från input i formulärdata till urler och tokens.

För att välja vilket environment som är aktivt hovrar man över det och klickar på den bockade cirkeln. Eller så kan man välja environment i dropdown menyn upp i högra hörnet som visar vilket environment som är aktivt för tillfället. Det gör det snabbt att byta environment variabler mellan t.ex. Produktion och Testning.

Globals är en speciell environment med variabler som alltid är tillgängliga för hela workspacet.

Det finns två typer av variabler i ditt enviroment; default och secret. Default syns som text, medans secret göms och är användbar för tokens, lösenord och annan känslig information. Om man vill avaktivera en variabel temporärt kan man bocka ur den.

Genom att trycka på ögat uppe i högra hörnet kan man snabbt se vilka variabler som är aktiva just nu, och ändra current value för att ersätta ett värde med ett nytt.

Ett extra tips!

Ange variabel {{$random}} - Postman använder faker library för att skapa dynamiska variabler man kan använda sig av för att slumpa fram ett värde genom att skriva in random och sen välja vad man är ute efter i en dropdown lista. Bra om man vill slippa skriva in nya variabler för anrop till databaser som tar unika värden.

Slutligen

Det här är en bara en del av det man kan göra med Postman, det finns många roliga funktioner som schemalagda och automatiska tester som vi inte ens hunnit röra vid än.

Men förhoppningsvis har det här gett lite insikt i ett program som vi använder och som våra backend-utvecklare har gett ett betyg på 4,5 av 5 stjärnor!

Här är en länk om du vill testa själv: https://www.postman.com

Skriv gärna och säg vad du tyckte, om det här inlägget hjälpte dig med din backend, eller om du har bra tips om Postman!