graphene django

Графен-Джанго

Graphene-Django — это библиотека с открытым исходным кодом, которая обеспечивает плавную интеграцию между Django, веб-фреймворком высокого уровня Python, и Graphene, библиотекой для создания API-интерфейсов GraphQL. Библиотека позволяет разработчикам быстро и эффективно создавать API-интерфейсы GraphQL в Django, сохраняя при этом высокий уровень производительности.

Функции

• Бесшовная интеграция с моделями Django.
• Автоматическое создание схемы GraphQL
• Интеграция с системой аутентификации и разрешений Django.
• Простой запрос и фильтрация данных
• Поддержка системы пагинации Django.
• Совместимость с формой и системой проверки Django.
• Обширная документация и поддержка сообщества.

Установка

Чтобы установить Graphene-Django, выполните следующую команду:

pip install graphene-django

Конфигурация

После установки добавьте «graphene_django» в список INSTALLED_APPS вашего проекта Django и определите схему GraphQL в настройках вашего проекта:

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

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

Использование

Чтобы использовать Graphene-Django, создайте файл schema.py в каталоге приложения Django и определите типы и запросы 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 )

Затем откройте API GraphQL в файле urls.py вашего проекта 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
]

Тестирование

Graphene-Django обеспечивает поддержку тестирования API-интерфейсов GraphQL с использованием тестового клиента Django. Чтобы создавать тесты, создайте tests.py в каталоге приложения Django и напишите свои тестовые примеры:

 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 ())

Содействие

Вклад в Graphene-Django всегда приветствуется! Для начала ознакомьтесь с системой отслеживания проблем репозитория и рекомендациями по участию.

Лицензия

Graphene-Django выпускается под лицензией MIT.

Ресурсы

• Официальный репозиторий GitHub
• Графен Документация
• Документация Джанго
• Спецификация GraphQL
• GraphiQL — браузерная IDE для изучения API GraphQL.
• Сообщество Graphene-Django. Присоединяйтесь к сообществу, чтобы обсуждать вопросы и делиться идеями, связанными с Graphene-Django.

Учебники и примеры

• Официальное руководство по Graphene-Django
• Создание API GraphQL с помощью Django и Graphene-Django
• Пример из реальной жизни: Django, Graphene и Relay.

Связанные проекты

• Graphene — библиотека для создания API-интерфейсов GraphQL на Python.
• Graphene-SQLAlchemy — интеграция между Graphene и SQLAlchemy, объектно-реляционным картографом (ORM) для Python
• Graphene-File-Upload — пакет, предоставляющий скаляр загрузки для обработки загрузки файлов в Graphene.
• Graphene-Subscriptions — пакет для добавления подписок в реальном времени к API-интерфейсам GraphQL на основе Graphene.

Поддерживать

Если у вас возникнут какие-либо проблемы или возникнут вопросы относительно Graphene-Django, сообщите о проблеме в официальном репозитории GitHub. Вы также можете обратиться за помощью и поделиться своим опытом с сообществом Graphene-Django на Discord.

Примечания к выпуску

• См. страницу релизов на github.