Generate static documentation for boxtribute GraphQL API using spectaql.
query-api-config.yml: Generate documentation only for GraphQL queries and relevant types. Mutations and input types are excluded. Intended for partner organisations who want to retrieve datafull-api-config.yml: Generate documentation of full GraphQL schema. Intended for internal boxtribute development
Substitute one of these file paths for some-config.yml in the command examples below.
You can run spectaql in your local environment, or via a provided Docker image. Select one of the following acc. to your taste.
First of all change the current directory to docs/graphql-api/.
- Run
npm install - Execute
npx spectaql some-config.yml
- Build the Docker image with
docker build -t spectaql .(alpine-based, 280MB) - Execute
spectaqlby./run some-config.yml
Open public/index.html in the web browser. (Alternatively you can add the -D flag to the previous spectaql command to start an HTTP server with file watcher and live reloading on port 4400)
See more options with the --help flag, or by inspecting the config files.
Run zip -r docs.zip public and distribute the zip file.