Skip to main content

Generate HTML docs for your GraphQL API

Project description

Graphdoc - Generate docs for your GraphQL API

Graphdoc uses you GraphQL schema to generate an HTML page documenting your API. It works with Graphene and Ariadne and any other framework generating GraphQLSchema instances from the graphql-core package.

You can see an example of autogenerated docs using the SWAPI schema in this page

Installation

Install using pip:

pip install graphdoc

Usage

You can use graphdoc.to_doc to convert a GraphQLSchema or a string to an HTML with the docs.

Django and Graphene

# view.py
from django.http import HttpResponse
from graphene_django.views import GraphQLView
import graphdoc

def graphql_docs(request):
    # For graphene>=3 use schema.graphql_schema
    # html = graphdoc.to_doc(GraphQLView().schema.graphql_schema)
    html = graphdoc.to_doc(GraphQLView().schema)
    return HttpResponse(html, content_type='text/html')


# urls.py
from graphene_django.views import GraphQLView
from .views import graphql_docs

urlpatterns = [
    path('graphql', GraphQLView.as_view(), name='graphql_endpoint'),
    path('docs', graphql_docs, name='graphql_docs'),
]

FastAPI and Ariadne

# schema.py
from ariadne import load_schema_from_path

schema = load_schema_from_path("schema.graphql")


# main.py
from fastapi import FastAPI, Response
from schema import schema
import graphdoc

app = FastAPI()


@app.get("/docs")
async def graphql_docs():
    html = graphdoc.to_doc(schema)
    return Response(content=html, media_type="text/html")

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

graphdoc-0.2.4.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

graphdoc-0.2.4-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file graphdoc-0.2.4.tar.gz.

File metadata

  • Download URL: graphdoc-0.2.4.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.3

File hashes

Hashes for graphdoc-0.2.4.tar.gz
Algorithm Hash digest
SHA256 f848bb8d3c49d5f690ae6a7610b96034beadf159d5f1a77a98101f31afc26db0
MD5 c78311dc934f4d6ddf43f636fc943066
BLAKE2b-256 8f91bfd3a64c0c1a740c1aa7c9c6e2afca6830712c22997594c45507e7b73746

See more details on using hashes here.

File details

Details for the file graphdoc-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: graphdoc-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.3

File hashes

Hashes for graphdoc-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8dad6581deba89d69df761bab451ab09b0a2b99b47bcc4bf1697cca8789f501b
MD5 824d8680bf08c4258d7b334be7e618ac
BLAKE2b-256 fde83f4bbd30701d611d686105350e48cfea42d2bffcb461c7cb40cb3a3c079a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page