GraphQL Schema Documentation Generator
Generates interactive API documentation from GraphQL schemas using graphql-js introspection queries and SpectaQL. Annotates fields with usage analytics from Apollo Studio API.
Installation
Use the upstream install or setup path that matches your environment:
- npm install --save graphql
- yarn add graphql
- npm install graphql@git://github.com/graphql/graphql-js.git#npm
Requirements and caveats from upstream:
- GraphQL.js is a general-purpose library and can be used both in a Node server
- with both CommonJS (require()) and ESModule (import) files. Ensure that any
Basic usage or getting-started notes:
A general overview of GraphQL is available in the
README for the
Specification for GraphQL. That overview
Extracted from upstream docs: https://raw.githubusercontent.com/graphql/graphql-js/HEAD/README.md
Source
Source: agentskillexchange/skills — distributed by TomeVault.