strawberry

Fresa GraphQL

Biblioteca Python GraphQL basada en clases de datos

Instalación (Inicio rápido)

El método de inicio rápido proporciona un servidor y una CLI para comenzar rápidamente. Instalar con:

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

Empezando

Cree un archivo llamado app.py con el siguiente código:

 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 )

Esto creará un esquema GraphQL que definirá un tipo User y un user de campo de consulta único que devolverá un usuario codificado.

Para ejecutar el servidor de depuración ejecute el siguiente comando:

strawberry server app

Abra el servidor de depuración haciendo clic en el siguiente enlace: http://0.0.0.0:8000/graphql

Esto abrirá GraphiQL donde podrá probar la API.

Comprobación de tipo

Strawberry viene con un complemento mypy que permite verificar estáticamente su esquema GraphQL. Para habilitarlo, agregue las siguientes líneas a su configuración mypy.ini :

 [mypy]
plugins = strawberry.ext.mypy_plugin

Integración de Django

Se proporciona una vista de Django para agregar un punto final GraphQL a su aplicación.

1. Agrega la aplicación a tu INSTALLED_APPS .

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

2. Agregue la vista a su archivo urls.py

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

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

WebSockets

Para admitir suscripciones a Graphql a través de WebSockets, debe proporcionar un servidor habilitado para WebSocket. Se puede hacer que el servidor de depuración admita WebSockets con estos comandos:

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

Ejemplos

• Varios ejemplos de cómo utilizar la fresa.
• Ejemplo de pila completa usando Starlette, SQLAlchemy, Typecript codegen y Next.js
• Tutorial de cuarto + fresa

Contribuyendo

Usamos poesía para gestionar dependencias, para comenzar sigue estos pasos:

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

Para obtener más detalles, consulte la página de contribución.

compromiso previo

Tenemos una configuración para confirmación previa, para agregar el enlace ejecute el siguiente comando:

pre-commit install

Campo de golf

• Página de inicio del proyecto: https://strawberry.rocks
• Repositorio: https://github.com/strawberry-graphql/strawberry
• Seguimiento de problemas: https://github.com/strawberry-graphql/strawberry/issues
  • En caso de errores sensibles, como vulnerabilidades de seguridad, comuníquese directamente con [email protected] en lugar de utilizar el rastreador de problemas. ¡Valoramos su esfuerzo por mejorar la seguridad y privacidad de este proyecto!

Licencias

El código de este proyecto tiene la licencia MIT. Consulte LICENCIA para obtener más información.