Why do We have to use Playground?

graphQL은 REST와 다른 생태계

REST는 url과 method로 API를 규정하고 값을 주고받는 반면, graphQL은 하나의 endpoint (http://myapi.com/graphql)에서 값을 주고받는다.

Untitled

Untitled

graphQL은 self-documenting(자체 문서화) 시스템을 가지고 있으며, 가져다가 사용하기만 하면 된다. 굳이 다른 문서화가 필요치 않다.

서버에서 graphQL을 이용하여 types, fields에 대한 description을 설명해 놓으며 이는 playground라는 플랫폼에서 각 값에 대한 설명으로 사용한다.

REST에서는 자체 문서화 하는 시스템이 없기 때문에 swagger 등의 API 디자인 툴을 이용해야 한다. graphQL에게는 편리하게 제공하지 않는다. (해보지는 않았지만 아마 만들기도 힘들고 설령 만들었다 해도 엄청 보기 안좋을 듯)

Untitled

graphQL의 자체 문서화 시스템은 playground에서 확인해 볼 수 있다.

보통 서버 관리자들은 로컬에서 작업하고 바로 확인하기 때문에 localhost에서 API 테스트가 가능하지만, 로컬에서 서버를 켜지 않는 사용자들은 배포되어 서버에 이미 올라가 있는 API를 테스트한다.

How to use?

브라우저에서 배포 서버 입력 혹은

playground 설치(GraphQL Playground | Apps | Electron ) 후 배포 서버 입력