A JavaScript API and CLI to test a GraphQL server for GraphQL over HTTP spec compliance.
To install from npm run:
npm install graphql-http-test --save-dev
Use either the CLI command graphql-http-test
or the API function graphqlHttpTest
to test your GraphQL server.
^10.17.0 || ^12.0.0 || >= 13.7.0
.The graphql-http-test
command tests that a GraphQL server at a given URI is GraphQL over HTTP spec compliant. It outputs test results to stdout
and stderror
accordingly, and exits with status 1
if tests failed.
It implements the function graphqlHttpTest
and has one argument; the GraphQL server URI.
npx example:
npx graphql-http-test http://localhost:3001/graphql
Audits that a GraphQL server at a given URI is GraphQL over HTTP spec compliant.
Parameter | Type | Description |
---|---|---|
uri |
string | GraphQL server URI. |
Returns: Promise<AuditResult> — Resolves once tests are complete.
Ways to import
.
import { graphqlHttpTest } from 'graphql-http-test';
import graphqlHttpTest from 'graphql-http-test/public/graphqlHttpTest.js';
Ways to require
.
const { graphqlHttpTest } = require('graphql-http-test');
const graphqlHttpTest = require('graphql-http-test/public/graphqlHttpTest');
Reports the result of an audit in a human readable format either to stderr
if the root audit has an error
status, or else to stdout
. Only intended for use in a Node.js environment.
Parameter | Type | Description |
---|---|---|
auditResult |
AuditResult | An audit result. |
Ways to import
.
import { reportAuditResult } from 'graphql-http-test';
import reportAuditResult from 'graphql-http-test/public/reportAuditResult.js';
Ways to require
.
const { reportAuditResult } = require('graphql-http-test');
const reportAuditResult = require('graphql-http-test/public/reportAuditResult');
An audit result.
Type: object
Property | Type | Description |
---|---|---|
description |
string | Audit description. |
status |
AuditResultStatus | Audit result status. |
children |
Array<AuditResult>? | Child audit results. |
An audit result status.
Type: ok
| warn
| error