graphene-django - 如何过滤?

时间:2016-11-02 14:07:31

标签: python django graphql graphene-python

我使用graphen-django构建GraphQL API。 我已经成功创建了这个API,但是我无法通过参数来过滤我的响应。

这是我的 models.py

from django.db import models

class Application(models.Model):
    name = models.CharField("nom", unique=True, max_length=255)
    sonarQube_URL = models.CharField("Url SonarQube", max_length=255, blank=True, null=True)

    def __unicode__(self):
    return self.name

这是我的 schema.py :     进口石墨烯     来自graphene_django导入DjangoObjectType     从模型导入应用程序

class Applications(DjangoObjectType):
    class Meta:
        model = Application

class Query(graphene.ObjectType):
    applications = graphene.List(Applications)

    @graphene.resolve_only_args
    def resolve_applications(self):
        return Application.objects.all()


schema = graphene.Schema(query=Query)

我的 urls.py

urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^admin/', admin.site.urls),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
    url(r'^api-token-auth/', authviews.obtain_auth_token),
    url(r'^graphql', GraphQLView.as_view(graphiql=True)),
]

如您所见,我还有一个REST API。

我的 settings.py 包含以下内容:

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

我遵循:https://github.com/graphql-python/graphene-django

当我发送此resquest时:

{
  applications {
    name
  }
}

我得到了这样的答复:

{
  "data": {
    "applications": [
      {
        "name": "foo"
      },
      {
        "name": "bar"
      }
    ]
   }
}

所以,它的作品!

但是当我试图传递这样的论点时:

{
  applications(name: "foo") {
    name
    id
  }
}

我有这样的回应:

{
  "errors": [
   {
      "message": "Unknown argument \"name\" on field \"applications\" of type \"Query\".",
      "locations": [
        {
          "column": 16,
          "line": 2
        }
      ]
    }
  ]
}

我错过了什么?或者我可能做错了什么?

3 个答案:

答案 0 :(得分:11)

我找到了一个解决方案,谢谢:http://docs.graphene-python.org/projects/django/en/latest/tutorial.html

这是我的答案。我已编辑 schema.py

import graphene
from graphene import relay, AbstractType, ObjectType
from graphene_django import DjangoObjectType
from graphene_django.filter import DjangoFilterConnectionField
from models import Application

class ApplicationNode(DjangoObjectType):
    class Meta:
        model = Application
        filter_fields = ['name', 'sonarQube_URL']
        interfaces = (relay.Node, )

class Query(ObjectType):
    application = relay.Node.Field(ApplicationNode)
    all_applications = DjangoFilterConnectionField(ApplicationNode)

schema = graphene.Schema(query=Query)

然后,它丢失了一个包:django-filter(https://github.com/carltongibson/django-filter/tree/master)。 Django-filter由DjangoFilterConnectionField使用。

现在我可以这样做:

query {
  allApplications(name: "Foo") {
    edges {
      node {
        name
      }
    }
  }
}

,响应将是:

{
  "data": {
    "allApplications": {
      "edges": [
        {
          "node": {
            "name": "Foo"
          }
        }
      ]
    }
  }
}

答案 1 :(得分:2)

Adrien Answer 的小补充。如果您想在过滤包含和完全匹配时执行不同的操作,请编辑您的 schema.py

class ApplicationNode(DjangoObjectType):
    class Meta:
        model = Application
        # Provide more complex lookup types
        filter_fields = {
            'name': ['exact', 'icontains', 'istartswith']
        }
        interfaces = (relay.Node, )

你可以这样写查询

  query {
  allApplications(name_Icontains: "test") {
    edges {
      node {
        id,
        name
      }
    }
  }
}

答案 2 :(得分:1)

如果就我而言,不想使用Relay,也可以使用Django orm过滤直接在解析器中处理过滤。此处的示例:Filter graphql query in django