Sådan testes GraphQL ved hjælp af Postman
1. Oversigt
I denne korte vejledning viser vi, hvordan man tester GraphQL-slutpunkter ved hjælp af Postman.
2. Oversigt over skemaer og metoder
Vi bruger de slutpunkter, der er oprettet i vores GraphQL-tutorial. Som en påmindelse indeholder skemaet definitioner, der beskriver indlæg og forfattere:
skriv Post {id: ID! titel: String! tekst: String! kategori: Stringforfatter: Forfatter! } skriv forfatter {id: ID! navn: String! miniaturebillede: Stringindlæg: [Indlæg]! }Derudover har vi metoder til at vise indlæg og skrive nye:
skriv forespørgsel {recentPosts (count: Int, offset: Int): [Post]! } skriv Mutation {writePost (titel: String !, tekst: String !, category: String): Post! }Når du bruger en mutation til at gemme data, vises påkrævede felter er markeret med et udråbstegn. Bemærk også, at i vores Mutation, den returnerede type er Stolpe, men i Forespørgsel, vi får en liste over Stolpe genstande.
Ovenstående skema kan indlæses i Postman API sektionen - bare tilføj Ny API med GraphQL skriv og tryk på Generer samling:
Når vi har indlæst vores skema, kan vi skriv let eksempler på forespørgsler ved hjælp af Postmans autofuldførelsesstøtte til GraphQL.
3. GraphQL-anmodninger i postbud
Først og fremmest tillader Postbud os at sende body i GraphQL-format - vi vælger bare indstillingen GraphQL nedenfor:
Derefter kan vi skrive en native GraphQL-forespørgsel, som en, der får os til titel, kategoriog forfatter navn ind i forespørgselssektionen:
forespørgsel {recentPosts (count: 1, offset: 0) {title category author {name}}}Og som et resultat får vi:
{"data": {"recentPosts": [{"title": "Post", "category": "test", "author": {"name": "Author 0"}}}}Det er også muligt at send en anmodning i råformatet, men vi er nødt til at tilføje Indholdstype: applikation / graphql til overskriftsafsnittet. Og i dette tilfælde ser kroppen den samme ud.
For eksempel kan vi opdatere titel, tekst, kategori, få en id og titel som svar:
mutation {writePost (titel: "Post", tekst: "test", kategori: "test",) {id titel}}Den type operation - lignende forespørgsel og mutation - kan udelades fra forespørgselsorganet, så længe vi bruger en stenografisk syntaks. I dette tilfælde kan vi ikke bruge navnet på operationen og variabler, men det anbefales at bruge operationens navn til lettere logning og fejlretning.
4. Brug af variabler
I sektionen variabler kan vi oprette et skema i JSON-format, der tildeler variablerne værdier. Dette undgår at skrive argumenter i en forespørgselsstreng:
Så vi kan ændre Seneste indlæg body i QUERY-sektionen for dynamisk at tildele værdier fra variabler:
forespørgsel recentPosts ($ count: Int, $ offset: Int) {recentPosts (count: $ count, offset: $ offset) {id titeltekstkategori}}Og vi kan redigere GRAPHQL VARIABLES sektionen med det, vi gerne vil have vores variabler indstillet til:
{"count": 1, "offset": 0}5. Resume
Vi kan nemt teste GraphQL ved hjælp af Postman, som også giver os mulighed for at importere skemaet og generere forespørgsler til det.
En samling af anmodninger kan findes på GitHub.
