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')),
-
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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86383a33dbe9b30f58c8aea65be6207384749c63325679080bdc999c72936c6e |
|
MD5 | aba8cb2577d152f88dfd6e6a5930cba0 |
|
BLAKE2b-256 | 0779e2f882e54ffdfcbc54c7cf743432fc8f71954593d57db4ee626f07c2af1f |