GraphQL¶

由于 FastAPI 基于 ASGI 标准，因此集成任何兼容 ASGI 的 GraphQL 库都非常容易。

您可以在同一个应用程序中将正常的 FastAPI 路径操作 与 GraphQL 结合使用。

提示

GraphQL 解决了某些非常特定的用例。

与常见的 Web API 相比，它有优点也有缺点。

请确保您评估一下，您用例的收益是否能弥补其缺点。🤓

GraphQL 库¶

以下是一些支持 ASGI 的 GraphQL 库。您可以将它们与 FastAPI 一起使用

Strawberry 🍓
- 附带 FastAPI 文档
Ariadne
- 附带 FastAPI 文档
Tartiflette
- 附带 Tartiflette ASGI 以提供 ASGI 集成
Graphene
- 附带 starlette-graphene3

使用 Strawberry 的 GraphQL¶

如果您需要或希望使用 GraphQL，Strawberry 是推荐的库，因为它的设计与 FastAPI 的设计最为接近，都基于 类型注解。

根据您的用例，您可能更喜欢使用不同的库，但如果您问我，我可能会建议您尝试 Strawberry。

这里是您如何将 Strawberry 与 FastAPI 集成的小示例

Python 3.8+

import strawberry
from fastapi import FastAPI
from strawberry.fastapi import GraphQLRouter


@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_app = GraphQLRouter(schema)

app = FastAPI()
app.include_router(graphql_app, prefix="/graphql")

您可以在 Strawberry 文档中了解更多关于 Strawberry 的信息。

还有关于 Strawberry 与 FastAPI 的文档。

Starlette 中较旧的 `GraphQLApp`¶

Starlette 的先前版本包含一个 GraphQLApp 类，用于与 Graphene 集成。

它已从 Starlette 中弃用，但如果您有使用它的代码，您可以轻松地迁移到 starlette-graphene3，它涵盖了相同的用例并且具有 几乎相同的接口。

提示

如果您需要 GraphQL，我仍然建议您查看 Strawberry，因为它基于类型注解而不是自定义类和类型。

了解更多¶

您可以在官方 GraphQL 文档中了解更多关于 GraphQL 的信息。

您还可以通过上述链接了解更多关于每个库的信息。