I den här artikeln kommer vi att se hur Postman används med vårt API.
Postman är en plattform för att bygga och använda API:er.
Postman kan användas via din webbläsare efter registrering. Postman-appen kan laddas ner här.
GET
Det här är fönstret du kommer att se när du har registrerat dig och öppnat Postman.
- GET – Här kommer du att definiera vilken typ av operation du vill utföra. I RecMan använder vi GET och POST, men i det här exemplet kommer vi att använda GET.
- URL – Om du utför en GET kan du ange en url med omfattning, typ och fält här. Se exempel i artiklarna.
- Skicka – När all information är på plats, tryck på Skicka för att utföra den valda åtgärden och hämta information från din databas.
-
Den här raden har några alternativ, men när du utför en GET behöver du bara oroa dig för knappen Rubriker. Fliken Rubrik måste innehålla följande information:
- Här visas vad din operation returnerade. I det här exemplet var returen Job Posts, och utgången är i JSON.
- Här kan du se dina tidigare operationer. Med lätthet kan du gå tillbaka till tidigare operationer och utföra dem igen.
POST
När du gör ett POST kommer din skärm att se något annorlunda ut och du kommer att definiera omfattningen, fälten och KEY på en annan plats.
Notera
Observera att varje operation som utförs med en POST kommer att göra ändringar i ditt system. Du kan eventuellt radera information i RecMan-systemet.
- POST – Vi har definierat att vi ska utföra ett POST från menyn.
- URL:en när du gör en POST är alltid https://api.recman.no/post/.
Notera
Se till att URL:en du använder när du kör och publicerar är identisk med detta, ett enda stavfel kommer att resultera i en misslyckad operation.
- SEND – När du har definierat allt, tryck på SEND för att utföra operationen.
- Medan Header borde se ut på samma sätt som det gjorde på GET, är det viktiga fältet här Body. Som visas i exemplet är din operation nu definierad av ett skript istället för URL, och här är syntaxen viktig. Se exempel i POST-artiklarna.
- Utgången. Det enda resultatet du får när du utför en POST är "success": sant eller "success": falskt beroende på hur framgångsrik operationen är.
- Loggen över dina tidigare GETs och POSTs.