Skip to main content

GraphQLdoc is a simple Django app to document GraphQL schemas.

Project description

GraphQLdoc

GraphQLdoc is a simple Django app to document GraphQL schemas.

Quick start

  1. Add graphqldoc to your INSTALLED_APPS setting like this:

     INSTALLED_APPS = [
         ...
         'graphqldoc',
     ]
    
  2. 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.

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

     path('docs/', include('graphqldoc.urls')),
    
  4. Start the development server and visit http://localhost:8000/docs/ to view the rendered documentation for your GraphQL server.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-graphqldoc, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size django_graphqldoc-0.1.1-py3-none-any.whl (9.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-graphqldoc-0.1.1.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page