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.

Source Distribution

django-graphqldoc-0.1.1.tar.gz (7.0 kB view hashes)

Uploaded source

Built Distribution

django_graphqldoc-0.1.1-py3-none-any.whl (9.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page