Test og Validering af API med Postman

Introduktion

Postman er et værdifuldt værktøj, når det kommer til databehandling og håndtering af parametre, der skal sendes og modtages. Det giver en enkel måde at komme i gang med at opsætte og teste API-forespørgsler på, inden de sættes i produktion. Ved at bruge Postman kan du ordne og organisere dine API-implementeringer, så du hurtigt og nemt kan få adgang til dem, når det er nødvendigt. Dette kan hjælpe dig med at optimere processen og få mest muligt ud af din tid og indsats.

1. Opret Workspace

At oprette et workspace er det første fundamentale skridt i enhver projektplanlægning og organisering. Et workspace er et virtuelt rum, der er designet til at fremme håndteringen af projekter..

Så i korthed, et workspace er en virtuel arbejdsplads, der er designet til at hjælpe med at koordinere, mens Collections er de enkelte komponenter

2. Opret Collection

Når du har oprettet dit workspace i Postman, er det vigtigt at tage et skridt videre og oprette en collection. Dette gøres ved at klikke på fanen "collections" og derefter trykke på knappen "Create Collection". Giv din collection et beskrivende navn, før du trykker på "Create". Dette er stedet, hvor dine anmodninger vil blive gemt, og du kan også oprette mapper for yderligere organisering. En god praksis er at bruge mapper til at beskrive processen og annotere, hvilke anmodninger der er beregnet til klient-side og server-side HTTP-anmodninger, da disse typisk kræver forskellige legitimationsoplysninger i deres anmodninger.

På denne måde kan du holde styr på dine anmodninger og sikre, at de er nemme at finde og bruge for dig selv eller dit team.

3. Godkendelse

Når din collection er oprettet i Postman, kan du nemt og hurtigt indsætte en authorization header for alle dine requests. Der er flere forskellige typer af authorization, men i de fleste tilfælde er det en Token-baseret autorisation med en API-token fra udbyderen, der er den mest anvendte. Det er godt at have en forståelse for de forskellige typer af authorization, så du kan vælge den rigtige for din situation. Som reference, er Basic Authentication, Token-Based Authentication og OAuth2 de mest almindelige typer, du vil støde på i din brug af API'er.

• Basic Authentication: Den fundamentale form for godkendelse, hvor du skal oplyse et legitimt brugernavn og password for at få adgang til API'en. Det er en enkel og nem metode, men ikke nødvendigvis den mest sikre løsning, da brugernavn og password kan være nemme at gætte eller blive kompromitteret. Derfor kan det være en god idé at overveje at implementere mere avancerede godkendelsesmetoder for at sikre en højere grad af sikkerhed.
• Token-Based Authentication: En sikker metode til at give adgang til API'en, da det kræver et gyldigt token. Dette gør det svært for uautoriserede brugere at få adgang til systemet og beskytter dermed dataene bag API'en. Det er en effektiv metode til at sikre, at kun autoriserede brugere har adgang til systemet og dets data.
• OAuth2: En almindeligt anvendt metode til at give sikker autorisation til API'er. Denne standard giver applikationer mulighed for at få adgang til en API på vegne af en bruger, uden at skulle dele brugerens legitimationsoplysninger. OAuth2 er en sikker og anerkendt metode, der er nem at implementere og administrere. Det giver en god balance mellem sikkerhed og brugervenlighed, og er derfor en af de mest anvendte metoder til autorisation i dag.

4. Tilføj anmodning

Nu hvor din collection er etableret, er det tid til at begynde at tilføje anmodninger til den. For at gøre dette skal du klikke på knappen 'Create Request' og give din anmodning et beskrivende navn. Dette navn vil hjælpe med at identificere anmodningen og gøre det lettere at finde den senere.

Efter at have givet din anmodning et navn, kan du begynde at indtaste URL'en, vælge HTTP-metoden og tilføje eventuelle nødvendige header- og body-oplysninger. Det er vigtigt at sørge for, at alle oplysninger er korrekte og relevante for den specifikke anmodning.

Når du har oprettet din anmodning, skal du klikke på knappen 'Gem' for at gemme den. Din nye anmodning vil nu blive tilføjet til din collection, hvor den vil være nem at finde og bruge senere.

• Det er vigtigt at sikre sig at end point er sat korrekt. Inden du sender en anmodning er det afgørende, at du tjekker at din anmodning har den korrekte destination, også kendt som en endpoint. En endpoint er en unik URL-slutpunkt, der peger på specifikke databaser og er nødvendig for at sikre, at din anmodning når frem til den rigtige modtager. At sikre, at endpoint er sat korrekt, kan spare tid og undgå unødvendige fejl, så det er vigtigt at tjekke det grundigt inden du sender din anmodning. En korrekt sat endpoint sikrer at din anmodning når frem til den rigtige modtager og giver mulighed for at forstå og arbejde med dataene på en korrekt måde.
• Bemærk HTTP Request Method. Det er også vigtigt at være opmærksom på HTTP-anmodningsmetoden, der skal bruges. Til venstre for URLen finder du en drop-down menu med de forskellige anmodningsmetoder, der er til rådighed. Det kan umiddelbart virke skræmmende at gennemgå listen, men det er vigtigt at bemærke, at de metoder, du med al sandsynlighed vil støde på i praksis, er GET, POST og DELETE metoderne.

5. Indsæt Header og Body

Når du har konfigureret URL'en og valgt den korrekte HTTP-metode, er det vigtigt at opsætte headerne og bodyen for din anmodning. Headere og body er vigtige elementer i en anmodning, da de giver information om, hvordan anmodningen skal behandles og hvilken data der skal sendes.

Afhængigt af API'et og formålet med anmodningen, kan det være nødvendigt at opsætte specifikke headers, såsom autoriserings-token eller accept-header. Det er vigtigt at sørge for, at alle relevante headers er opsat korrekt, da det kan påvirke anmodningens resultat.

Bodyen er også en vigtig del af anmodningen, da det er her dataene sendes. Afhængigt af anmodningen og metoden, kan det være nødvendigt at sende specifik data i bodyen. Det er vigtigt at sørge for, at dataene i bodyen er korrekte og relevante for

6. Se response

Efter at have opsat URL, HTTP-metode, header og body, er det tid til at sende din anmodning ved at klikke på knappen 'Send'. Når du har sendt anmodningen, vil den resulterende respons blive vist under sektionen med de give parametre. Dette giver dig mulighed for at undersøge responsen og afgøre om anmodningen er gennemført korrekt.

Normalt vil responsen være i form af et respons-body, som ofte er i JSON-format. Det giver dig mulighed for at modtage information og bruge det i din integration. Hvis der er et problem med anmodningen, vil der i stedet være en JSON-respons med en fejlmeddelelse, som beskriver problemet.

Når du har modtaget responsen, er det vigtigt at undersøge hvilken del af integrationen der er et problem og rette dette. Derved kan du sikre dig, at alt er opsat korrekt, når du integrerer det i dit site.

7. Så er du i gang!

Nu når du har modtaget de responser, du forventede fra dine API-anmodninger, er det tid til at integrere koden i dit websted. Dette skulle være en relativt enkel proces, da der i højre hjørne af vinduet finder du en kode '</>' menu, der giver dig mulighed for at få adgang til eksempler på, hvordan du implementerer den aktuelle anmodning i dit websted. Det giver dig mulighed for at vælge den bedste metode til din opsætning.

Det er vigtigt at være grundig og tage sig tid til at undersøge og teste din kode, inden du implementerer det i dit websted, så du kan være sikker på, at alt fungerer korrekt.

Jeg ønsker dig held og lykke med integrationen, og håber at dette guide har hjulpet dig med at forstå processen bedre.