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
-
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')),
-
Run
python manage.py migrate
to create the graphqldoc models. -
Start the development server and visit http://localhost:8000/docs/ to view the rendered documentation for your GraphQL server.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django_graphqldoc-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49a57d0f3c339dc10dc64fd77c9f3e41a280960a4e6a9b4076c022565a9e0289 |
|
MD5 | cad2af0d8bbfa63de9cf8082c52e2602 |
|
BLAKE2b-256 | 6faf073065606c746f6513dce272cb3fab19ab83ccd51827bf42a04e91513475 |