how to export schema in graphene django

Exporting Schema in Graphene Django

To export the schema in Graphene Django, you can follow these steps:

  1. Import the necessary modules:
  2. In your Django project, open the file where you define your GraphQL schema. This is typically a file named or similar.
  3. Import the necessary modules: from graphene_django import DjangoObjectType and import graphene.

  4. Define your GraphQL types:

  5. Create a Django model for which you want to create a GraphQL type. For example, if you have a Book model, you can create a corresponding BookType using DjangoObjectType.
  6. In the file, define your GraphQL types by subclassing DjangoObjectType and specifying the model and any additional fields you want to include.

  7. Define the Query and Mutation classes:

  8. Create a Query class that inherits from graphene.ObjectType.
  9. Inside the Query class, define the fields that represent the queries you want to expose in your GraphQL API. For example, if you want to query books, you can define a field called books that returns a list of BookType.
  10. Similarly, if you have mutations, create a Mutation class that inherits from graphene.ObjectType and define the mutation fields.

  11. Create the schema:

  12. After defining the types, queries, and mutations, create the schema by calling graphene.Schema(query=Query, mutation=Mutation) and assigning it to a variable, such as schema.

  13. Export the schema:

  14. To export the schema, you can use the schema.introspect() method, which returns a JSON representation of the schema.
  15. You can then save this JSON representation to a file or use it for other purposes.

Here's an example of how the code might look:

from graphene_django import DjangoObjectType
import graphene
from .models import Book

class BookType(DjangoObjectType):
    class Meta:
        model = Book
        fields = "__all__"

class Query(graphene.ObjectType):
    books = graphene.List(BookType)

    def resolve_books(self, info):
        return Book.objects.all()

class Mutation(graphene.ObjectType):
    # Define your mutation fields here

schema = graphene.Schema(query=Query, mutation=Mutation)

# Export the schema
schema_json = schema.introspect()
with open("schema.json", "w") as f:

Please note that this is a simplified example, and you may need to modify it based on your specific project structure and requirements.