The GraphQL ecosystem keeps growing. Today I want to bring GraphDoc under your attention. GraphDoc will take your existing GraphQL API and generate instant documentation for it.
Go to https://graphdoc.io/:
Enter the URL of your public GraphQL schema:
And you get a documentation website back:
If you want to change the default configuration, GraphDoc will check for a the existence of .well-known/graphql.json
file on the same domain as your GraphQL API. So if your API runs on https://api.example.com/graphql the config will be expected at https://api.example.com/.well-known/graphql.json.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"title": "My GraphQL API", | |
"description": "Awesome API that provides a ton of value.", | |
"favicon_url": "http://static.example.com/favicon.ico", | |
"logo_light_url": "http://static.example.com/logo-light.svg", | |
"logo_dark_url": "http://static.example.com/logo-dark.svg", | |
"headers": { | |
"Authorization": "Bearer MyPublicSecret" | |
} | |
} |