django-graphqldoc

GraphQLdoc

GraphQLdoc is a simple Django app to document GraphQL schemas.

Quick start

• Add graphqldoc to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...
       'graphqldoc',
   ]
  

• Add GRAPHQLDOC config settings in your settings file, and configure according to your needs, like this:

   GRAPHQLDOC = {
       'LOGO_URL': 'https://graphql.org/img/logo.svg',
       'TITLE': 'My GraphQL documentation',
   }
  

  This step is optional, it changes the logo and the default title in the template.

• Include the graphqldoc URLconf in your project urls.py like this:

   path('docs/', include('graphqldoc.urls')),
  

• Start the development server and visit http://localhost:8000/docs/ to view the rendered documentation for your GraphQL server.