PostMan으로 GraphQL요청 하기

 
오늘은 GraphQL개발을 진행하며 요청과 응답을 클라이언트 관점에서 확인해 볼 수 있도록 PostMan을 활용하여 서버로 요청을 보내는 법을 공유해 보도록 하겠습니다.

RestApi를 개발해오며 정말 많이 사용한 PostMan입니다. 예전에 PostMan으로 gRPC요청도 해보았는데 PostMan으로 GraphQL요청 또한 손쉽게 가능합니다.

요청할 서버는 localhost:8080 로컬환경입니다. GraphQL은 한개의 엔드포인트만 갖기에 graphql로 요청을 보낼 수 있도록 설정합니다. 또한 GraphQL은 본질적으로 HTTP 프로토콜 이기 때문에 GET, POST를 설정할 수 있습니다. 다만 일반적으로 GET요청에 대한 한계가 있기 때문에 대부분 GraphQL 요청은 POST로 처리합니다. 이 부분은 한번 검색을 하셔서 찾아보시는 것도 좋을 것 같습니다.

GraphQL은 엔드포인트로 클라이언트의 의도를 파악하는게 아닌 실질적인 쿼리로 의도를 파악하기 때문에 쿼리를 작성해 주셔야 합니다. 해당 쿼리는 HTTP 프로토콜 Body영역에 명시를 해주어야 합니다.

Body탭을 클릭후 GraphQL라디오 버튼을 클릭해 줍니다.
 

Query 영역에 Query를 작성해 줍니다. 필요에 따라 GraphQL Variables 영역에 전달하고자 하는 값들을 전달해 줍니다.

응답 Body영역을 확인하시면 GraphQL 응답이온걸 확인하실 수 있습니다.

이번에는 mutation요청을 해보도록 하겠습니다. 대체적으로 mutation요청은 RestApi Post요청과 비슷하죠 mutation Query와 
GraphQL Variables을 작성해 줍니다.

mutation요청에 의해 새롭게 등록된 게시글에 대한 정보가 응답 Body값으로 전달된 부분을 확인할 수 있습니다.

GraphQL은 HTTP프로토콜을 따르기 때문에 일반적으로 Header Token 인증을 한다면 Authorization탭에서 토큰을 명시하여 GraphQL요청을 보낼 수 있습니다.

마지막으로 PostMan Code snippet창에서 작성한 요청을 다양한 코드의 방식으로 확인하실 수 있습니다. GraphQL 백엔드 개발을 하신다면 PostMan으로 간단하게 백엔드 서버가 이상없이 동작하는지 확인하실 수 있습니다. 개발에 참고하시면 좋을 것 같습니다.
 
그러면 이상 짧을 글을 마치도록 하겠습니다. 행복코딩 하세요.