Strawberry GraphQL

Warnings

• breaking In `v0.243.0`, support for GraphQL multipart file uploads was disabled by default, requiring explicit opt-in. Additionally, Django CSRF protection became enabled by default for Strawberry Django views, requiring the `csrf_exempt` decorator if previous behavior is desired. [2]
  Fix: For multipart uploads, explicitly set `multipart_uploads_enabled=True` in your view configuration. For Django CSRF, add `@csrf_exempt` to your `GraphQLView.as_view()` in `urls.py` if you need to disable it. [2]
• breaking In `v0.268.0`, the generated GraphQL schema type for `GlobalID` (when using `relay.Node`) was changed to `ID`. While runtime behavior is unaffected, schema introspection will now report `ID` instead of `GlobalID`. [6]
  Fix: Update any client-side code or tools that expect the `GlobalID` type in the schema to now expect `ID`. If legacy behavior is required, set `config=StrawberryConfig(relay_use_legacy_global_id=True)` when initializing the schema. [6]
• deprecated In `v0.213.0`, the `graphiql` parameter used in HTTP integration views (e.g., `GraphQLView` for FastAPI, Flask, Django) was deprecated and replaced by `graphql_ide`. [11]
  Fix: Replace `graphiql=True` with `graphql_ide='graphiql'` (or `'apollo-sandbox'`, `'vega'`) in your view configuration. Example: `GraphQLView.as_view(schema=schema, graphql_ide='graphiql')`. [11]
• breaking The `types` parameter in `strawberry.union()` was deprecated in `v0.191.0` and completely removed in `v0.312.0`. [5]
  Fix: Migrate to using Python's native `|` operator for unions (e.g., `str | int`) or `typing.Union` (e.g., `typing.Union[str, int]`). A codemod is available: `strawberry upgrade annotated-union <path>`. [5]
• gotcha The `strawberry.ext.mypy_plugin` has seen significant changes across versions. It was removed in `v0.269.0` (as it was no longer needed due to `@dataclass_transform`) but partially restored in `v0.310.2` to support experimental Pydantic types. Relying on its specific behavior or even its presence can be inconsistent. [5]
  Fix: Review your `mypy.ini` configuration. If you're not using experimental Pydantic types, you might be able to remove `strawberry.ext.mypy_plugin`. If you are, ensure you're on a compatible version and understand its current limitations. Pydantic users primarily need `pydantic.mypy_plugin`. [5]

Install

• pip install strawberry-graphql Core library
• pip install "strawberry-graphql[cli]" With CLI and dev server
• pip install "strawberry-graphql[fastapi]" With FastAPI integration
• pip install "strawberry-graphql[django]" With Django integration

Imports

• strawberry.type

  import strawberry
  @strawberry.type

  Decorator for defining GraphQL object types, interfaces, or input types. [3, 4]
• strawberry.field

  import strawberry
  @strawberry.field

  Decorator for defining fields on GraphQL types, allowing custom resolvers or descriptions. [3, 4]
• strawberry.Schema

  import strawberry
  schema = strawberry.Schema(query=Query)

  Class to create the executable GraphQL schema. [3, 4]
• strawberry.ID

  import strawberry
  id: strawberry.ID

  Scalar type for unique identifiers, commonly used in Relay. [8]
• strawberry.lazy

  from typing import TYPE_CHECKING, Annotated, List
  import strawberry
  
  if TYPE_CHECKING:
      from .posts import Post
  
  posts: List[Annotated["Post", strawberry.lazy(".posts")]]

  Used for lazy evaluation of types to resolve circular dependencies between modules. [22]
• strawberry.ext.mypy_plugin

  The plugin is now less critical or has changed, review mypy.ini.

  The mypy plugin was initially removed in v0.269.0 due to new Python features (`@dataclass_transform`) and later restored with minimal support in v0.310.2 for experimental Pydantic types. Direct use might be unnecessary or require updates. [5]

Quickstart

This quickstart demonstrates how to define a simple GraphQL schema with a `User` type and a `Query` field that returns a hardcoded user. It then instantiates a `strawberry.Schema` and explains how to run it using Strawberry's built-in development server and CLI. [3, 4]

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)

# To run this example locally:
# 1. Install with `pip install "strawberry-graphql[cli]"`
# 2. Save the code above as `app.py`
# 3. Run `strawberry dev app` in your terminal.
# 4. Access the GraphiQL interface at http://0.0.0.0:8000/graphql in your browser.