graphene django

Grafeno-Django

Graphene-Django es una biblioteca de código abierto que proporciona una integración perfecta entre Django, un marco web Python de alto nivel, y Graphene, una biblioteca para crear API GraphQL. La biblioteca permite a los desarrolladores crear API GraphQL en Django de forma rápida y eficiente manteniendo un alto nivel de rendimiento.

Características

• Integración perfecta con los modelos de Django
• Generación automática de esquema GraphQL
• Integración con el sistema de autenticación y permisos de Django.
• Fácil consulta y filtrado de datos.
• Soporte para el sistema de paginación de Django.
• Compatible con el sistema de validación y formulario de Django.
• Amplia documentación y soporte comunitario.

Instalación

Para instalar Graphene-Django, ejecute el siguiente comando:

pip install graphene-django

Configuración

Después de la instalación, agregue 'graphene_django' a la lista INSTALLED_APPS de su proyecto Django y defina el esquema GraphQL en la configuración de su proyecto:

 INSTALLED_APPS = [
    # ...
    'graphene_django' ,
]

GRAPHENE = {
    'SCHEMA' : 'myapp.schema.schema'
}

Uso

Para usar Graphene-Django, cree un archivo schema.py en el directorio de su aplicación Django y defina sus tipos y consultas GraphQL:

 import graphene
from graphene_django import DjangoObjectType
from . models import MyModel

class MyModelType ( DjangoObjectType ):
    class Meta :
        model = MyModel

class Query ( graphene . ObjectType ):
    mymodels = graphene . List ( MyModelType )

    def resolve_mymodels ( self , info , ** kwargs ):
        return MyModel . objects . all ()

schema = graphene . Schema ( query = Query )

Luego, expone la API GraphQL en el archivo urls.py de tu proyecto Django:

 from django . urls import path
from graphene_django . views import GraphQLView
from . import schema

urlpatterns = [
    # ...
    path ( 'graphql/' , GraphQLView . as_view ( graphiql = True )), # Given that schema path is defined in GRAPHENE['SCHEMA'] in your settings.py
]

Pruebas

Graphene-Django brinda soporte para probar las API GraphQL utilizando el cliente de prueba de Django. Para crear pruebas, cree un archivo tests.py en el directorio de su aplicación Django y escriba sus casos de prueba:

 from django . test import TestCase
from graphene_django . utils . testing import GraphQLTestCase
from . import schema

class MyModelAPITestCase ( GraphQLTestCase ):
    GRAPHENE_SCHEMA = schema . schema

    def test_query_all_mymodels ( self ):
        response = self . query (
            '''
            query {
                mymodels {
                    id
                    name
                }
            }
            '''
        )

        self . assertResponseNoErrors ( response )
        self . assertEqual ( len ( response . data [ 'mymodels' ]), MyModel . objects . count ())

Contribuyendo

¡Las contribuciones a Graphene-Django siempre son bienvenidas! Para comenzar, consulte el rastreador de problemas y las pautas de contribución del repositorio.

Licencia

Graphene-Django se publica bajo la licencia MIT.

Recursos

• Repositorio oficial de GitHub
• Documentación de grafeno
• Documentación de Django
• Especificación GraphQL
• GraphiQL: un IDE en el navegador para explorar las API de GraphQL
• Comunidad Graphene-Django: únase a la comunidad para discutir preguntas y compartir ideas relacionadas con Graphene-Django

Tutoriales y ejemplos

• Tutorial oficial de Graphene-Django
• Construyendo una API GraphQL con Django y Graphene-Django
• Ejemplo del mundo real: Django, Graphene y Relay

Proyectos Relacionados

• Graphene: una biblioteca para crear API GraphQL en Python
• Graphene-SQLAlchemy: integración entre Graphene y SQLAlchemy, un mapeador relacional de objetos (ORM) para Python
• Graphene-File-Upload: un paquete que proporciona un escalar de carga para manejar la carga de archivos en Graphene
• Graphene-Subscriptions: un paquete para agregar suscripciones en tiempo real a las API GraphQL basadas en Graphene

Apoyo

Si encuentra algún problema o tiene preguntas sobre Graphene-Django, no dude en enviar un problema en el repositorio oficial de GitHub. También puedes pedir ayuda y compartir tus experiencias con la comunidad Graphene-Django en Discord

Notas de la versión

• Ver la página de lanzamientos en github