GraphQL vs Restful api

[kangraemin]

작업 도중에 학습 한 내용 / 공유 할만한 내용들을 공유 하는것을 원칙으로 진행합니다.

이슈 내용

API 서버를 구축하기 위한 통신 방법으로 GraphQL과 REST api를 학습하고, 통신 방법을 선택 해야 합니다.

해당 이슈에서는 API를 위해 REST api / GraphQL 중 어떠한 것을 선택 할 지 고민 / 학습 한 내용을 공유합니다.

추가적으로, Django에서 REST api를 위한 라이브러리인 DRF ( Django REST Framework ) 와 GraphQL을 위한 라이브러리인 Graphene / Ariadne 에 대해 학습한 것을 공유합니다.

다음 작업들이 진행되어야 합니다.

• [x] Nomad coder app 부분 DRF 수강 후 정리
• [x] Nomad coder app 부분 GraphQL 수강 후 정리
• [x] RESTful api의 장단점 정리
• [x] GraphQL의 장단점 정리
• [x] 서비스 DB schema 재정리
• [x] 서비스에서 요청 될 예상 api 목록 정리
• [x] 서비스에 REST api 을 적용 했을 때 장단점 정리
• [x] 서비스에 GraphQL을 적용 했을 때 장단점 정리
• [x] Client측에서 사용하는 Apollo에 대한 정리

[kangraemin]

DRF / Graphene / NodeJS GraphQL

기술적인 상세한 내용( 구체적인 구현 방식 )은 따로 정리하지 않겠습니다.

구체적인 구현 방식은 각 기술의 공식 홈페이지를 참조 해주시고, 아래의 내용은 제가 공부 했던 내용들을 확인 할 수 있는 링크들 입니다. 참고 부탁드립니다.

• Notion : https://www.notion.so/API-3b18f38bc62545a1994ceafd2165551f

• NodeJS GraphQL ( using graphql-yoga ) : https://github.com/kangraemin/NodeJS-GraphQL-Study

• Django GraphQL ( using Graphene-Django ) : https://github.com/kangraemin/Django-GraphQL-Study

• Django REST ( using DRF ) : https://github.com/kangraemin/Django-REST-Study

[kangraemin]

장고를 서버 프레임워크로 이용 할 것이기 때문에, 장고 위주로 REST / GraphQL을 비교 하도록 하겠습니다.

REST ( DRF )

장점

• Django에서는, REST를 구현 하기 위해 DRF ( Django REST Framework, https://www.django-rest-framework.org/ )를 주로 씁니다.
• DRF 공식 홈페이지 문서화가 잘 되어 있습니다.
• 미리 구현되어 있는 기능들이 많습니다. ( 하루 api 호출 횟수 제한, 시간당 보낼 수 있는 api 호출 횟수 제한 등 ... 자세한 내용은 DRF 공식문서 참조 )
• 공식 홈페이지 이외에도 정리를 잘 해놓은 곳들이 여럿 있습니다. ( http://cdrf.co/ )
• Django에 맞추어 개발이 용이 합니다. ( ViewSet / GenericView를 활용하면, Django의 Model과 연동하는것이 상당히 쉬워집니다. )
• 서버를 구체적으로 구축하는데 학습하기가 어렵지 않습니다.
• 이미 많이 쓰여 익숙한 개념입니다. ( URL + method 만으로 통신, 직관적인 url 구성 가능 )
• DRF를 쓰는 사용자가 Graphene 보다 많고, 이미 많은 곳에서 사용 중에 있습니다.

단점

• REST api 특성상 Over fetching / Under fetching 문제가 있을 수 있습니다. ( 참고 : 참고자료 )
• Django 특성상 파일 구조가 복잡 해 질 수 있습니다. ( Permission / Serializers ... )

GraphQL ( Graphene )

장점

• Over fetching / Under fetching에 대한 문제점이 없습니다.
• Graphene-django를 이용 하면 쉽게 구현 할 수 있습니다.
• 하나의 endpoint(url)로 관리 할 수 있습니다.
• resolver에 REST api call로 구현된 함수를 사용 할 수 있습니다. ( -> 겉모습은 GraphQL처럼 client와 통신하나, 내부적으로는 REST api call을 진행 ) 따라서 GrpahQL과 REST를 혼용하여 쓸 수 있습니다.

단점

• 자료가 DRF에 비하면 적습니다. ( Nomad coder에 따르면, 에러 해결 할 떄 참고 할만한 자료가 확실히 적다고 합니다. )
• Grphene을 쓰는 곳이 많이 확인되지는 않습니다.
• DRF의 단점과 마찬가지로, 파일 구조가 복잡 해 질 수 있습니다. ( queries, mutations, schema ... )
• 로그인 등 인증에 대한 자료가 많은것 같지는 않습니다.

결론

개발의 편리함과 안정성을 위해 첫번째 api 배포 ( api version 1 )에서는 DRF를 사용 하되, Over / Under fetching문제가 계속해서 대두된다면 GraphQL을 v2로 도입하도록 하겠습니다.

[kangraemin]

Apollo는 클라이언트 측에서 GraphQL 통신을 편하게 해주는 라이브러리입니다.

GraphQL이 필요하여 도입 할 시에 정리하도록 하겠습니다.

[kangraemin]

구현해야할 API 리스트는 이슈 / 문서를 따로 만들어 관리하겠습니다.