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 )

這將建立一個 GraphQL 架構，定義一個User類型和一個將傳回硬編碼使用者的單一查詢欄位user 。

若要執行調試伺服器，請執行以下命令：

strawberry server app

點擊以下連結開啟調試伺服器：http://0.0.0.0:8000/graphql

這將打開 GraphiQL，您可以在其中測試 API。

類型檢查

Strawberry 隨附了一個 mypy 插件，可以對 GraphQL 模式進行靜態類型檢查。若要啟用它，請將以下行新增至mypy.ini配置：

 [mypy]
plugins = strawberry.ext.mypy_plugin

Django 集成

提供了 Django 視圖，用於將 GraphQL 端點新增至您的應用程式。

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 )),
]

WebSockets

若要支援透過 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 許可。請參閱許可證以了解更多資訊。