graphene django

石墨烯-Django

Graphene-Django 是一个开源库，可在 Django（高级 Python Web 框架）和 Graphene（用于构建 GraphQL API 的库）之间提供无缝集成。该库允许开发人员在 Django 中快速高效地创建 GraphQL API，同时保持高水平的性能。

特征

• 与 Django 模型无缝集成
• 自动生成 GraphQL 模式
• 与 Django 的身份验证和权限系统集成
• 轻松查询和过滤数据
• 支持 Django 的分页系统
• 与 Django 的表单和验证系统兼容
• 广泛的文档和社区支持

安装

要安装 Graphene-Django，请运行以下命令：

pip install graphene-django

配置

安装后，将“graphene_django”添加到 Django 项目的INSTALLED_APPS列表中，并在项目设置中定义 GraphQL 架构：

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

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

用法

要使用 Graphene-Django，请在 Django 应用程序目录中创建schema.py文件并定义 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 )

然后，在 Django 项目的urls.py文件中公开 GraphQL API：

 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 支持使用 Django 的测试客户端测试 GraphQL API。要创建测试，请在 Django 应用程序目录中创建一个tests.py文件并编写测试用例：

 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 存储库
• 石墨烯文档
• Django 文档
• GraphQL 规范
• GraphiQL - 用于探索 GraphQL API 的浏览器内 IDE
• Graphene-Django 社区 - 加入社区讨论与 Graphene-Django 相关的问题并分享想法

教程和示例

• 石墨烯-Django 官方教程
• 使用 Django 和 Graphene-Django 构建 GraphQL API
• 真实示例：Django、Graphene 和 Relay

相关项目

• Graphene - 用于在 Python 中构建 GraphQL API 的库
• Graphene-SQLAlchemy - Graphene 和 SQLAlchemy（Python 的对象关系映射器（ORM））之间的集成
• Graphene-File-Upload - 提供上传标量的包，用于处理 Graphene 中的文件上传
• Graphene-Subscriptions - 用于向基于 Graphene 的 GraphQL API 添加实时订阅的包

支持

如果您遇到任何问题或对 Graphene-Django 有疑问，请随时在官方 GitHub 存储库上提交问题。您还可以在 Discord 上的 Graphene-Django 社区寻求帮助并分享您的经验

发行说明

• 请参阅 github 上的发布页面