graphql-doc-check
Advanced tools
Quickly find any missing documentation in your GraphQL API using introspection. Performs inspections remotely, without any need to access code.
npm install -g graphql-doc-check
Calling graphql-doc-check without any arguments will assume that your GraphQL
API is running at http://localhost:80/graphql.
$ graphql-doc-check
Alternatively, you can pass a URL to check.
$ graphql-doc-check https://example.com/graph
For more info, consult the help:
$ graphql-doc-check -h
Results are shown in a tree structure with fields missing documentation in red.
Type1
├─ field1 [missing | properties]
│ ├─ arg1
│ ├─ arg2
└─ field2
└─ arg3 [description]
Copyright (c) 2016, Jordan Adams
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
FAQs
Check for missing documentation in your GraphQL Schema
The npm package graphql-doc-check receives a total of 2 weekly downloads. As such, graphql-doc-check popularity was classified as not popular.
We found that graphql-doc-check demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.