strawberry

딸기 GraphQL

데이터 클래스 기반 Python GraphQL 라이브러리

설치(빠른 시작)

빠른 시작 방법은 빠르게 시작할 수 있도록 서버와 CLI를 제공합니다. 다음을 사용하여 설치:

pip install " strawberry-graphql[debug-server] " 

시작하기

다음 코드를 사용하여 app.py 라는 파일을 만듭니다.

 import strawberry


@ strawberry . type
class User :
    name : str
    age : int


@ strawberry . type
class Query :
    @ strawberry . field
    def user ( self ) -> User :
        return User ( name = "Patrick" , age = 100 )


schema = strawberry . Schema ( query = Query )

그러면 User 유형을 정의하는 GraphQL 스키마와 하드코딩된 사용자를 반환하는 단일 쿼리 필드 user 생성됩니다.

디버그 서버를 실행하려면 다음 명령을 실행하십시오.

strawberry server app

다음 링크를 클릭하여 디버그 서버를 엽니다: http://0.0.0.0:8000/graphql

그러면 API를 테스트할 수 있는 GraphiQL이 열립니다.

유형 확인

Strawberry에는 GraphQL 스키마를 정적으로 유형 검사할 수 있는 mypy 플러그인이 함께 제공됩니다. 이를 활성화하려면 mypy.ini 구성에 다음 줄을 추가하세요.

 [mypy]
plugins = strawberry.ext.mypy_plugin

장고 통합

애플리케이션에 GraphQL 엔드포인트를 추가하기 위해 Django 뷰가 제공됩니다.

1. INSTALLED_APPS 에 앱을 추가하세요.

 INSTALLED_APPS = [
    ...,  # your other apps
    "strawberry.django" ,
]

2. urls.py 파일에 보기를 추가하세요.

 from strawberry . django . views import GraphQLView
from . schema import schema

urlpatterns = [
    ...,
    path ( "graphql" , GraphQLView . as_view ( schema = schema )),
]

웹소켓

WebSocket을 통한 graphql 구독을 지원하려면 WebSocket 지원 서버를 제공해야 합니다. 다음 명령을 사용하여 디버그 서버가 WebSocket을 지원하도록 만들 수 있습니다.

pip install ' strawberry-graphql[debug-server] '
pip install ' uvicorn[standard] ' 

예

• 딸기 활용법에 대한 다양한 예시
• Starlette, SQLAlchemy, Typescript codegen 및 Next.js를 사용한 전체 스택 예
• 쿼트 + 딸기 튜토리얼

기여

시를 사용하여 종속성을 관리하고 시작하려면 다음 단계를 따르세요.

git clone https://github.com/strawberry-graphql/strawberry
cd strawberry
poetry install --with integrations
poetry run pytest

더 자세한 내용은 기여 페이지를 확인하세요.

사전 커밋

사전 커밋을 위한 구성이 있습니다. 후크를 추가하려면 다음 명령을 실행하세요.

pre-commit install

모래밭

• 프로젝트 홈페이지: https://strawberry.rocks
• 저장소: https://github.com/strawberry-graphql/strawberry
• 이슈 트래커: https://github.com/strawberry-graphql/strawberry/issues
  • 보안 취약점과 같은 민감한 버그의 경우 이슈 트래커를 사용하는 대신 [email protected]으로 직접 문의하시기 바랍니다. 우리는 이 프로젝트의 보안과 개인 정보 보호를 개선하기 위한 귀하의 노력을 소중하게 생각합니다!

라이선스

이 프로젝트의 코드는 MIT 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 라이센스를 참조하세요.