EDITORS

API보다 유연한 무엇을 찾아 나서다 API를 기획하거나 제작 하다보면 엔드포인트에서 유연하게 작동할 수 있는 무엇(?)을 원하게 된다. 그러다보면 API에서 필드의 스콥을 정하는 필드를 만드는 악수를 두는 상황이 벌어질 수도 있다 중급이상 개발자야 알고있거나 찾아놨거나 만들었겠지만 뭐 여튼 이래저래 찾다보면 GraphQL을 만나게 된다. GraphQL GraphQL은 애플리케이션 프로그래밍 인터페이스(API)를 위한 쿼리 언어이자 서버측 런타임으로 클라이언트에게 요청한 만큼의 데이터를 제공하는 데 우선 순위를 부여한다 바로 이점 에서 장점이 생기는데 이부분으로 인해 차후 네트워크 대역폭을 절약시키는 데 도움을 주기도 한다. 파이썬 (#python) 최근들어서 #머신러닝 이나 #AI 관련 프로젝트에 대한 이야기만 나오면 나오는 언어가 바로 파이썬이다. GraphQL공식 사이트 가보면 알겠지만 프로젝트의 큰 부분을 차지하는게 JS 지만 관리 하는 입장이라면 아무래도 통합적으로 관리하기를 원할 수 있다보니 API 도 파이썬으로 개발 운영 해보는걸로 택했다. FastAPI + GraphQL (#strawberry) + SQLmodel 파이썬에 대해서 알아가는 중이기도 하지만 조금만 찾아보면 API만든다고 하면 많은 메뉴얼이 뜨고 있는 FastAPI(이름부터 마음에 듬) 를 택했다. 문제는 GraphQL 작성을 위한 프레임워크 인데 가장 많이 쓰이고 있는게 Graphene (star 7.7k) 이다. 코드를 보니 크게 어려운건 없지만 2위의 #strawberry 가 유독 끌렸다. 깃헙에서 스타갯수도 3.2k 로 한참 밀리는 느낌이지만 릴리즈 수가 압도적이었다. (어떤면에서 불안할 수 있다고 할 수 있겠지만 크게 Deprecated 되는 것이 없었다) ORM은 직관적이라고 판단한 SQLmodel을 활용하기로 했다. 패키지 관리 패키지 관리툴은 poetry를 사용 했다. [tool.poetry.dependencies] python = "^

지원되는 타입 GraphQL은 아래와 같은 타입을 지원한다. 스칼라 타입 (Scalar types) 개체 타입 (Object types) 쿼리 타입 (The Query type) 뮤테이션 타입 (The Mutation type) 입력 타입 (Input types) 스칼라 타입 (Scalar types) 스칼라 타입은 Python 의 기본 타입과 유사하다. Int: 32비트 정수 integer는 Python의 int 에 매핑 Float: Python의 float에 매핑 String: 파이썬의 str에 매핑 Boolean(참 또는 거짓)은 파이썬의 bool에 매핑 고유 식별자 ID는 문자열로 직렬화되고 다음과 같이 사용 가능 strawberry.ID(“value”) 개체를 가져오거나 캐시의 키로 사용됨 UUID, 문자열로 직렬화된 UUID 값 @ Strawberry는 날짜, 시간 및 날짜/시간 개체에 대한 지원을 포함하고 있다. 공식적으로 GraphQL 사양에는 포함되어 있지 않지만 대부분 서버에서 지원하고 있다. ISO-8601 (날짜와 시간과 관련된 데이터 교환을 다루는 국제 표준) 로 일련번호가 지정되어 있다. 기초 적인 스칼라 타입의 요소로도 작동하지만 고유한 스칼라 타입을 지원한다. 개체 타입(The Query type) GraphQL 스키마에서 정의하는 대부분의 타입은 객체 타입이고 개체 타입에는 필드 모음이 포함되며 각 필드는 스칼라 타입 이나 다른 개체형일 수 있다. Tip. "개체 타입"은 이전 스키마 에서와 같이 서로를 참조할 수 있다. import typing import strawberry @strawberry.type class Book: title: str author: "Author" @strawberry.type class Author: name: str books: typing.List[Book] 필드에 데이

GraphQL 서버는 스키마를 사용하여 데이터의 모델을 설명할 수 있다. 데이터 테이블에 필드가 있는 유형 의 계층 구조를 정의한다. 또한 클라이언트가 실행할 수 있는 query(읽기) 와 mutation(쓰기, 수정)을 제공한다. 스키마의 기본과 Strawberry를 사용하여 빌드하는 방법에 대해 알아보자 스키마 정의 언어(SDL : Schema definition language) GraphQL 서버 스키마를 생성하는 방법에는 두 가지가 있다. 하나는 "스키마" 우선 방식 그리고 또 다른 하나는 "코드" 우선 방식 이다. Strawberry 는 코드 우선 방식으로 정의한 스키마만 지원한다. 코드 우선 방식으로 들어가기 전에 스키마 정의가 무엇인지 알아보자. 스키마(Schema) 는 GraphQL 사양에 포함된 GraphQL의 스키마 정의 언어를 사용함으로써 작동하는 것을 의미한다. SDL을 사용하여 정의한 스키마의 예시 type Book { title: String! author: Author! } type Author { name: String! books: [Book!]! } 스키마는 이들 사이의 모든 유형과 관계를 정의한다. 이를 통해 클라이언트 개발자는 사용 가능한 데이터를 확인하고 해당 데이터를 특정하여 하위 집합을 요청할 수 있다. @ !(느낌표) 필드가 null을 허용하지 않음을 지정한다. 스키마는 데이터를 가져오는 방법을 지정하지 않는다. 나중에 리졸버를 정의할 때 구현한다. 코드 우선 접근 방식 위에 언급했듯이 Strawberry는 코드 우선 접근 방식을 사용한다. 아래 예시를 보면 쉽게 이해 할 수 있다. import typing import strawberry @strawberry.type class Book: title: str author: "Author" @strawberry.type class Aut

이 튜토리얼(https://strawberry.rocks/docs)은 다음과 같이 활용이 될 수 있다 GraphQL 원리에 대한 기본적인 이해를 돕는다 Strawberry를 사용하여 GraphQL 스키마 정의 할 수 있다. 스키마에 대해 쿼리를 실행할 수 있는 Strawberry 서버 를 구축 할 수 있다. 사용자가 명령줄과 Python에 익숙하고 최신 버전의 Python(3.7+)이 설치되어 있다고 가정한다. Strawberry는 Python의 데이터 클래스 및 유형 힌트 기능 위에 구축됩니다. 1단계: 새 프로젝트 생성 및 Strawberry 설치 virtualenv 를 통해서 "strawberry debug" 서버를 설치설치 한다 $ mkdir strawberry-demo $ cd strawberry-demo $ python -m venv virtualenv $ source virtualenv/bin/activate $ pip install 'strawberry-graphql[debug-server]' 2단계: 스키마 정의 모든 GraphQL 서버는 스키마를 사용하여 클라이언트가 쿼리할 수 있는 데이터 구조를 정의한다. 하기 예제에서 타이틀과 예약자를 이용하는 예약(부킹) 쿼리하는 서비스를 구성한다. 에디터에서 schema.py 파일을 생성하고 다음 내용이 포함될 수 있도록 한다. # schema.py import typing import strawberry @strawberry.type class Book: title: str # 예약 타이틀 author: str # 예약자 @strawberry.type class Query: books: typing.List[Book] 클라이언트가 0개 이상의 부킹 목록을 반환하는 쿼리를 실행할 수 있는 GraphQL 스키마가 생성되었다. 3단계: 데이터 세트 정의 이제 스키마 구조가 있으므로 데이터 자체를 정의할 수 있다.